> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# PollsResource

> Poll APIs.

* `create(chat, title, choices, options)` creates a poll message.
* `get(pollMessage)` reads the latest poll state.
* `vote(pollMessage, optionId, options)` casts or changes the local
  account's vote.
* `unvote(pollMessage, options)` removes the local account's vote.
* `addOption(pollMessage, text, options)` appends a new choice.
* `subscribeEvents(filter)` streams poll changes.

## Methods

### addOption()

```typescript
addOption(pollMessage: string, text: string, options?: IdempotencyOptions): Promise<Poll>
```

#### Parameters

<ResponseField name={"pollMessage"} type={"string"} required />

<ResponseField name={"text"} type={"string"} required />

<ResponseField name={"options"} type={"IdempotencyOptions"} typeHref={"/reference/stable/advanced-imessage/grpc/interfaces/IdempotencyOptions"} />

#### Returns

<code>{"Promise<"}[Poll](/docs/reference/stable/advanced-imessage/grpc/interfaces/Poll){">"}</code>

### create()

```typescript
create(chat: string, title: string, choices: string[], options?: IdempotencyOptions): Promise<Poll>
```

#### Parameters

<ResponseField name={"chat"} type={"string"} required />

<ResponseField name={"title"} type={"string"} required />

<ResponseField name={"choices"} type={"string[]"} required />

<ResponseField name={"options"} type={"IdempotencyOptions"} typeHref={"/reference/stable/advanced-imessage/grpc/interfaces/IdempotencyOptions"} />

#### Returns

<code>{"Promise<"}[Poll](/docs/reference/stable/advanced-imessage/grpc/interfaces/Poll){">"}</code>

### get()

```typescript
get(pollMessage: string): Promise<Poll>
```

#### Parameters

<ResponseField name={"pollMessage"} type={"string"} required />

#### Returns

<code>{"Promise<"}[Poll](/docs/reference/stable/advanced-imessage/grpc/interfaces/Poll){">"}</code>

### subscribeEvents()

```typescript
subscribeEvents(filter?: { pollMessage: string }): TypedEventStream<PollEvent>
```

#### Parameters

<ResponseField name={"filter"} type={"{ pollMessage: string }"} />

#### Returns

<code>[TypedEventStream](/docs/reference/stable/advanced-imessage/grpc/classes/TypedEventStream){"<"}[PollEvent](/docs/reference/stable/advanced-imessage/grpc/interfaces/PollEvent){">"}</code>

### unvote()

```typescript
unvote(pollMessage: string, options?: IdempotencyOptions): Promise<Poll>
```

#### Parameters

<ResponseField name={"pollMessage"} type={"string"} required />

<ResponseField name={"options"} type={"IdempotencyOptions"} typeHref={"/reference/stable/advanced-imessage/grpc/interfaces/IdempotencyOptions"} />

#### Returns

<code>{"Promise<"}[Poll](/docs/reference/stable/advanced-imessage/grpc/interfaces/Poll){">"}</code>

### vote()

```typescript
vote(pollMessage: string, optionId: string, options?: IdempotencyOptions): Promise<Poll>
```

#### Parameters

<ResponseField name={"pollMessage"} type={"string"} required />

<ResponseField name={"optionId"} type={"string"} required />

<ResponseField name={"options"} type={"IdempotencyOptions"} typeHref={"/reference/stable/advanced-imessage/grpc/interfaces/IdempotencyOptions"} />

#### Returns

<code>{"Promise<"}[Poll](/docs/reference/stable/advanced-imessage/grpc/interfaces/Poll){">"}</code>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.