Class PollContext

Hierarchy

Context<IPoll>
- PollContext

Index

Constructors

Properties

_client _source client

Accessors

allowsMultipleAnswers correctOptionId explanation explanationEntities id isAnonymous isClosed openPeriod options question totalVoterCount type

Methods

getPollOptionByText getPollOptionPercentage toContext

Constructors

constructor

new PollContext(_client, _source): PollContext
Parameters
- _client: Evogram
- _source: IPoll
Returns PollContext
Inherited from Context.constructor
- Defined in src/modules/context/Context.ts:4

Properties

`Protected` _client

_client: Evogram

`Protected` _source

_source: IPoll

client

client: Evogram = ...

Accessors

allowsMultipleAnswers

get allowsMultipleAnswers(): boolean
Returns true if the poll allows multiple answers.

Returns boolean
- Defined in src/contexts/Poll/PollContext.ts:22

correctOptionId

get correctOptionId(): undefined | number
Gets the ID of the correct answer option, if specified.

Returns undefined | number
- Defined in src/contexts/Poll/PollContext.ts:24

explanation

get explanation(): undefined | string
Gets the text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, if specified.

Returns undefined | string
- Defined in src/contexts/Poll/PollContext.ts:26

explanationEntities

get explanationEntities(): undefined | IMessageEntity
Gets the entities that appear in the explanation text, if specified.

Returns undefined | IMessageEntity
- Defined in src/contexts/Poll/PollContext.ts:28

id

get id(): string
Gets the ID of the poll.

Returns string
- Defined in src/contexts/Poll/PollContext.ts:8

isAnonymous

get isAnonymous(): boolean
Returns true if the poll is anonymous.

Returns boolean
- Defined in src/contexts/Poll/PollContext.ts:18

isClosed

get isClosed(): boolean
Returns true if the poll is closed.

Returns boolean
- Defined in src/contexts/Poll/PollContext.ts:16

openPeriod

get openPeriod(): undefined | number
Gets the amount of time in seconds the poll will be active after creation, if specified.

Returns undefined | number
- Defined in src/contexts/Poll/PollContext.ts:30

options

get options(): IPollOption[]
Gets the list of poll options.

Returns IPollOption[]
- Defined in src/contexts/Poll/PollContext.ts:12

question

get question(): string
Gets the question text of the poll.

Returns string
- Defined in src/contexts/Poll/PollContext.ts:10

totalVoterCount

get totalVoterCount(): number
Gets the total number of users that voted in the poll.

Returns number
- Defined in src/contexts/Poll/PollContext.ts:14

type

get type(): "regular" | "quiz"
Gets the type of the poll.

Returns "regular" | "quiz"
- Defined in src/contexts/Poll/PollContext.ts:20

Methods

getPollOptionByText

getPollOptionByText<T>(text): undefined | T
This method searches for a poll option with the given text among all the options in the poll.
Type Parameters
- T extends Context<IPollOption, T> = any
Parameters
- text: string
  
  Parameter specifies the text to search for.
Returns undefined | T
The found poll option.
- Defined in src/contexts/Poll/PollContext.ts:38

getPollOptionPercentage

getPollOptionPercentage(option): number
Returns the percentage of votes for the transmitted option
Parameters
- option: IPollOption
  
  Poll option from which to calculate the percentage
Returns number
Percentage of those who voted for option
- Defined in src/contexts/Poll/PollContext.ts:48

toContext

toContext<TContext>(): TContext
Converts the source object to a context object of a given type.

Example
```
client.updates.on("message", message => {
        const user = message.user.toContext<CustomUserContext>();
        // Now user works correctly with your context
    })
```
Type Parameters
- TContext extends object
  
  Generic type parameter for the context object.
Returns TContext
The context object.
Inherited from Context.toContext
- Defined in src/modules/context/Context.ts:16

Generated using TypeDoc