Class PhotoDAO

Hierarchy

AbstractDAO
- PhotoDAO

Index

Constructors

constructor

Accessors

http

Methods

Constructors

constructor

new PhotoDAO(impl: ITwitarrHTTP | IHasHTTP): PhotoDAO

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 PhotoDAO

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

get

get(id: string): Promise<PhotoDetails>

- Defined in dao/PhotoDAO.ts:12
Retrieve a photo's metadata.

Parameters
- id: string
Returns Promise<PhotoDetails>

Protected handleErrors

handleErrors(result: TwitarrResult<any>): any

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

post

post(fileName: string, photoData: Buffer): Promise<PhotoDetails>

- Defined in dao/PhotoDAO.ts:50
Post a photo.

Parameters
- fileName: string
- photoData: Buffer
Returns Promise<PhotoDetails>

profile

profile(username: string, fileName: string, photoData: Buffer): Promise<PhotoDetails>

- Defined in dao/PhotoDAO.ts:75
Post a profile photo.

Parameters
- username: string
- fileName: string
- photoData: Buffer
Returns Promise<PhotoDetails>

put

put(id: string, newFileName: string): Promise<PhotoDetails>

- Defined in dao/PhotoDAO.ts:26
Update the "original filename" metadata on a photo.

Parameters
- id: string
- newFileName: string
Returns Promise<PhotoDetails>

remove

remove(id: string): Promise<TwitarrResult<any>>

- Defined in dao/PhotoDAO.ts:43
Delete/remove a photo..

Parameters
- id: string
Returns Promise<TwitarrResult<any>>

removeProfile

removeProfile(): Promise<any>

- Defined in dao/PhotoDAO.ts:100
Remove the user's profile photo.

Returns Promise<any>

Generated using TypeDoc