CompetitionSuggestion | @daostack/arc.js

Hierarchy

CompetitionSuggestion

Implements

IStateful<ICompetitionSuggestionState>

Index

Constructors

constructor

Properties

Methods

Object literals

fragments

Constructors

constructor

new CompetitionSuggestion(idOrOpts: string | object | ICompetitionSuggestionState, context: Arc): CompetitionSuggestion

- Defined in src/schemes/competition.ts:668
Parameters
- idOrOpts: string | object | ICompetitionSuggestionState
- context: Arc
Returns CompetitionSuggestion

Properties

context

context: Arc

id

id: string

Optional staticState

staticState: ICompetitionSuggestionState

Optional suggestionId

suggestionId: undefined | number

Methods

fetchStaticState

fetchStaticState(): Promise<ICompetitionSuggestionState>

- Defined in src/schemes/competition.ts:695
Returns Promise<ICompetitionSuggestionState>

getPosition

getPosition(): Promise<null | number>

- Defined in src/schemes/competition.ts:733
Returns Promise<null | number>

isWinner

isWinner(): Promise<boolean>

- Defined in src/schemes/competition.ts:739
Returns Promise<boolean>

redeem

redeem(): Operation<boolean>

- Defined in src/schemes/competition.ts:745
Returns Operation<boolean>

setStaticState

setStaticState(opts: ICompetitionSuggestionState): void

- Defined in src/schemes/competition.ts:691
Parameters
- opts: ICompetitionSuggestionState
Returns void

state

state(apolloQueryOptions?: IApolloQueryOptions): Observable<ICompetitionSuggestionState>

- Defined in src/schemes/competition.ts:699
Parameters
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<ICompetitionSuggestionState>

vote

vote(): Operation<CompetitionVote>

- Defined in src/schemes/competition.ts:713
Returns Operation<CompetitionVote>

votes

votes(options?: ICompetitionVoteQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<CompetitionVote[]>

- Defined in src/schemes/competition.ts:724
Parameters
- Default value options: ICompetitionVoteQueryOptions = {}
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<CompetitionVote[]>

Static calculateId

calculateId(opts: object): string

- Defined in src/schemes/competition.ts:573
Parameters
- opts: object
  - scheme: Address
  - suggestionId: number
Returns string

Static Private mapItemToObject

mapItemToObject(item: any, context: Arc): ICompetitionSuggestionState | null

- Defined in src/schemes/competition.ts:632
Parameters
- item: any
- context: Arc
Returns ICompetitionSuggestionState | null

Static search

search(context: Arc, options?: ICompetitionSuggestionQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<CompetitionSuggestion[]>

- Defined in src/schemes/competition.ts:581
Parameters
- context: Arc
- Default value options: ICompetitionSuggestionQueryOptions = {}
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<CompetitionSuggestion[]>

Object literals

Static fragments

fragments: object

CompetitionSuggestionFields

CompetitionSuggestionFields: DocumentNode = gql`fragment CompetitionSuggestionFields on CompetitionSuggestion {idsuggestionIdproposal {id}descriptionHashtitledescriptionurltags {id}# fulltext: [string]beneficiarysuggester# votes: [CompetitionVote!] @derivedFrom(field: "suggestion")totalVotescreatedAtredeemedAtrewardPercentagepositionInWinnerList}`

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

idOrOpts: string | object | ICompetitionSuggestionState

context: Arc

Returns CompetitionSuggestion

Properties

context

id

Optional staticState

Optional suggestionId

Methods

fetchStaticState

Returns Promise<ICompetitionSuggestionState>

getPosition

Returns Promise<null | number>

isWinner

Returns Promise<boolean>

redeem

Returns Operation<boolean>

setStaticState

Parameters

opts: ICompetitionSuggestionState

Returns void

state

Parameters

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<ICompetitionSuggestionState>

vote

Returns Operation<CompetitionVote>

votes

Parameters

Default value options: ICompetitionVoteQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<CompetitionVote[]>

Static calculateId

Parameters

opts: object

scheme: Address

suggestionId: number

Returns string

Static Private mapItemToObject

Parameters

item: any

context: Arc

Returns ICompetitionSuggestionState | null

Static search

Parameters

context: Arc

Default value options: ICompetitionSuggestionQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<CompetitionSuggestion[]>

Object literals

Static fragments

CompetitionSuggestionFields