Class Poll

Hierarchy

Base
- Poll

Implements

PollInterface

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Poll(client: Client, group: Group, creator: User, data: APIPoll): Poll

Overrides Base.constructor
- Defined in src/structures/Poll.ts:30
Parameters
- client: Client
- group: Group
- creator: User
- data: APIPoll
Returns Poll

Properties

Private _active

_active: boolean

Readonly client

client: Client

createdAt

createdAt: number

creator

creator: User

expiresAt

expiresAt: number

group

group: Group

Readonly id

id: string

multi

multi: boolean

Optional myVote

myVote: string | string[]

options

options: Collection<string, PollOption>

public

public: boolean

question

question: string

updatedAt

updatedAt: number

Optional voters

voters: Collection<string, string> | Collection<string, string[]>

Accessors

active

get active(): boolean

- Defined in src/structures/Poll.ts:80
Returns boolean

canEnd

get canEnd(): boolean

- Defined in src/structures/Poll.ts:77
Returns boolean

Methods

_clone

_clone(): any

Inherited from Base._clone
- Defined in src/structures/Base.ts:11
Returns any

_patch

_patch(data: Partial<APIPoll>): Poll

Overrides Base._patch
- Defined in src/structures/Poll.ts:52
Parameters
- data: Partial<APIPoll>
Returns Poll

end

end(): Promise<Poll>

Implementation of PollInterface.end
- Defined in src/structures/Poll.ts:74
Returns Promise<Poll>

fetch

fetch(): Promise<Poll>

Implementation of PollInterface.fetch
- Defined in src/structures/Poll.ts:71
Returns Promise<Poll>

vote

vote(option: string | PollOption): Promise<Poll>
vote(options: (string | PollOption)[]): Promise<Poll>

Implementation of PollInterface.vote
- Defined in src/structures/Poll.ts:66
Parameters
- option: string | PollOption
Returns Promise<Poll>
Implementation of PollInterface.vote
- Defined in src/structures/Poll.ts:67
Parameters
- options: (string | PollOption)[]
Returns Promise<Poll>

Generated using TypeDoc