Class EventDAO

Hierarchy

AbstractDAO
- EventDAO

Index

Constructors

constructor

Accessors

http

Methods

Constructors

constructor

new EventDAO(impl: ITwitarrHTTP | IHasHTTP): EventDAO

Inherited from AbstractDAO.constructor
- Defined in dao/AbstractDAO.ts:11
Construct a DAO instance.

Parameters
- impl: ITwitarrHTTP | IHasHTTP
  
  The HTTP implementation to use. It is also legal to pass any object conforming to the IHasHTTP interface (like a Client).
Returns EventDAO

Accessors

http

get http(): ITwitarrHTTP
set http(impl: ITwitarrHTTP): void

Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:29
The HTTP implementation to use internally when making DAO requests.

Returns ITwitarrHTTP
Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:33
The HTTP implementation to use internally when making DAO requests.

Parameters
- impl: ITwitarrHTTP
Returns void

Methods

all

all(): Promise<any>

- Defined in dao/EventDAO.ts:43
Retrieve the complete list of events.

Returns Promise<any>

favorite

favorite(id: string): Promise<boolean>

- Defined in dao/EventDAO.ts:68
Favorite an event.

Parameters
- id: string
Returns Promise<boolean>

get

get(id: string): Promise<Event>

- Defined in dao/EventDAO.ts:56
Retrieve an individual event.

Parameters
- id: string
Returns Promise<Event>

getDay

getDay(date: Moment, mine?: boolean): Promise<any>

- Defined in dao/EventDAO.ts:134
Retrieve the list of events for a given day.

Parameters
- date: Moment
- Optional mine: boolean
Returns Promise<any>

Protected handleErrors

handleErrors(result: TwitarrResult<any>): any

Inherited from AbstractDAO.handleErrors
- Defined in dao/AbstractDAO.ts:37
Parameters
- result: TwitarrResult<any>
Returns any

remove

remove(id: string): Promise<boolean>

- Defined in dao/EventDAO.ts:94
Remove an individual event. (Must be an admin.)

Parameters
- id: string
Returns Promise<boolean>

unfavorite

unfavorite(id: string): Promise<boolean>

- Defined in dao/EventDAO.ts:81
Un-favorite an event.

Parameters
- id: string
Returns Promise<boolean>

update

update(id: string, title?: string, description?: string, location?: string, start_time?: Moment, end_time?: Moment): Promise<Event>

- Defined in dao/EventDAO.ts:106
Update an individual event. (Must be an admin.)

Parameters
- id: string
- Optional title: string
- Optional description: string
- Optional location: string
- Optional start_time: Moment
- Optional end_time: Moment
Returns Promise<Event>

Generated using TypeDoc