Class EventBinaryService

Hierarchy (View Summary)

Service<IEventBinary>
- EventBinaryService

Index

Constructors

Methods

delete download list upload

Constructors

constructor

new EventBinaryService(
client: IFetchClient,
realtime?: Realtime,
): EventBinaryService
Parameters
- client: IFetchClient
- Optionalrealtime: Realtime
Returns EventBinaryService
Inherited from Service.constructor
- Defined in packages/client/src/core/Service.ts:18

Methods

delete

delete(entityOrId: string | number | IEvent): Promise<IResult<null>>
Removes the binary for a given event.
Parameters
- entityOrId: string | number | IEvent
Returns Promise<IResult<null>>
Response wrapped in [[IResult]]
Overrides Service.delete
- Defined in packages/client/src/event/EventBinaryService.ts:82

download

download(entityOrId: string | number | IEvent): Promise<IFetchResponse>
Downloads the binary for a given event.
Parameters
- entityOrId: string | number | IEvent
Returns Promise<IFetchResponse>
Response wrapped in [[IFetchResponse]]
- Defined in packages/client/src/event/EventBinaryService.ts:61

list

list(filter?: object): Promise<IResultList<IEventBinary>>
Parameters
- filter: object = {}
Returns Promise<IResultList<IEventBinary>>
Inherited from Service.list
- Defined in packages/client/src/core/Service.ts:32

upload

upload(
file: Stream | Blob | Buffer | File,
entityOrId: string | number | IEvent,
): Promise<IResult<IEventBinary>>
Uploads an event binary.
Parameters
- file: Stream | Blob | Buffer | File
  file to upload.
- entityOrId: string | number | IEvent
Returns Promise<IResult<IEventBinary>>
Response wrapped in [[IResult]]
- Defined in packages/client/src/event/EventBinaryService.ts:29