event.md

@daostack/client › Globals › Event

Class: Event

Hierarchy

• Event

Implements

• IStateful‹IEventState›

Index

Constructors

• constructor

Properties

• context
• id
• idOrOpts
• staticState

Methods

• fetchStaticState
• setStaticState
• state
• search

Object literals

• fragments

Constructors

constructor

+ new Event(idOrOpts: string | IEventStaticState, context: Arc): Event

Defined in event.ts:90

Parameters:

Name	Type
idOrOpts	string | IEventStaticState
context	Arc

Returns: Event

Properties

context

• context: Arc

Defined in event.ts:92

---

id

• id: string

Defined in event.ts:89

---

idOrOpts

• idOrOpts: string | IEventStaticState

Defined in event.ts:92

---

staticState

• staticState: IEventStaticState | undefined

Defined in event.ts:90

Methods

fetchStaticState

▸ fetchStaticState(): Promise‹IEventStaticState›

Defined in event.ts:135

Returns: Promise‹IEventStaticState›

---

setStaticState

▸ setStaticState(opts: IEventStaticState): void

Defined in event.ts:131

Parameters:

Name	Type
opts	IEventStaticState

Returns: void

---

state

▸ state(apolloQueryOptions: IApolloQueryOptions): Observable‹IEventState›

Defined in event.ts:102

Parameters:

Name	Type	Default
apolloQueryOptions	IApolloQueryOptions	{}

Returns: Observable‹IEventState›

---

Static search

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

Defined in event.ts:56

Event.search(context, options) searches for reward entities

Parameters:

Name	Type	Default	Description
context	Arc	-	an Arc instance that provides connection information
options	IEventQueryOptions	{}	the query options, cf. IEventQueryOptions
apolloQueryOptions	IApolloQueryOptions	{}	-

Returns: Observable‹Event[]›

an observable of Event objects

Object literals

Static fragments

▪ fragments: object

Defined in event.ts:34

EventFields

• EventFields: any = gqlfragment EventFields on Event { id dao { id } type data user proposal { id } timestamp }

Defined in event.ts:35