competition.md

@daostack/client › Globals › Competition

Class: Competition

Hierarchy

• Competition

Index

Constructors

• constructor

Properties

• context
• id

Methods

• createSuggestion
• redeemSuggestion
• suggestions
• voteSuggestion
• search

Constructors

constructor

+ new Competition(id: string, context: Arc): Competition

Defined in schemes/competition.ts:419

Parameters:

Name	Type
id	string
context	Arc

Returns: Competition

Properties

context

• context: Arc

Defined in schemes/competition.ts:419

---

id

• id: string

Defined in schemes/competition.ts:418

Methods

createSuggestion

▸ createSuggestion(options: object): Operation‹any›

Defined in schemes/competition.ts:427

Parameters:

▪ options: object

Name	Type
description	string
tags?	string[]
title	string
url?	undefined | string

Returns: Operation‹any›

---

redeemSuggestion

▸ redeemSuggestion(suggestionId: number, beneficiary: Address): Operation‹boolean›

Defined in schemes/competition.ts:488

Parameters:

Name	Type	Default
suggestionId	number	-
beneficiary	Address	NULL_ADDRESS

Returns: Operation‹boolean›

---

suggestions

▸ suggestions(options: ICompetitionSuggestionQueryOptions, apolloQueryOptions: IApolloQueryOptions): Observable‹CompetitionSuggestion[]›

Defined in schemes/competition.ts:500

Parameters:

Name	Type	Default
options	ICompetitionSuggestionQueryOptions	{}
apolloQueryOptions	IApolloQueryOptions	{}

Returns: Observable‹CompetitionSuggestion[]›

---

voteSuggestion

▸ voteSuggestion(suggestionId: number): Operation‹CompetitionVote›

Defined in schemes/competition.ts:477

Parameters:

Name	Type
suggestionId	number

Returns: Operation‹CompetitionVote›

---

Static search

▸ search(context: Arc, options: IProposalQueryOptions, apolloQueryOptions: IApolloQueryOptions): Observable‹Competition[]›

Defined in schemes/competition.ts:408

Parameters:

Name	Type	Default
context	Arc	-
options	IProposalQueryOptions	{}
apolloQueryOptions	IApolloQueryOptions	{}

Returns: Observable‹Competition[]›