@auvious/filetransfer / FileTransferService
Class: FileTransferService
Supports transferring of files from one user to another.
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new FileTransferService(commonSource, rtcSource?): FileTransferService
FileTransferService Constructor.
Parameters
| Name | Type | Description |
|---|---|---|
commonSource | Observable<AuviousCommon> | AuviousClient mandatory |
rtcSource? | Observable<AuviousRtc> | optional, if provided and registered then userEndpointId parameters are automatically filled when making requests, resulting in events that have a valid userEndpointId. |
Returns
Properties
apiResource
• Private apiResource: ApiResource
fileTransferEventSubscription
• Private fileTransferEventSubscription: IEventClientSubscription
fileTransferEventsSubject
• Private fileTransferEventsSubject: Subject<FileTransferredEvent>
rtc
• Private rtc: AuviousRtc
Methods
find
▸ find(params): Promise<FileTransfer[]>
Parameters
| Name | Type |
|---|---|
params | { filter: boolean ; interactionId: string } | { conferenceId: string ; filter: boolean } |
Returns
Promise<FileTransfer[]>
findByConferenceId
▸ findByConferenceId(conferenceId, filter?): Promise<FileTransfer[]>
Returns all FileTransfer objects that match conferenceId. If you need to get all files sent from you, you can filter by userId. If you need to get all files sent to you, you can filter by targetType=="USER" and targetId=={your-user-id}.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
conferenceId | string | undefined | conferenceId id to query by |
filter | boolean | false | if true, server filters out file transfers not sent or received by you. Default is false, which returns all file transfers related to conference id |
Returns
Promise<FileTransfer[]>
a promise that resolves to an array of FileTransfer objects
findByInteractionId
▸ findByInteractionId(interactionId, filter?): Promise<FileTransfer[]>
Returns all FileTransfer objects that match interactionId. If you need to get all files sent from you, you can filter by userId. If you need to get all files sent to you, you can filter by targetType=="USER" and targetId=={your-user-id}.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
interactionId | string | undefined | interaction id to query by |
filter | boolean | false | if true, server filters out file transfers not sent or received by you. Default is false, which returns all file transfers related to interaction id |
Returns
Promise<FileTransfer[]>
a promise that resolves to an array of FileTransfer objects
incoming
▸ incoming(): Observable<FileTransfer>
Use this to receive any files sent to your endpoint.
Returns
Observable<FileTransfer>
an observable of FileTransfer objects
signedUrlProvider
▸ signedUrlProvider(): SignedUrlProvider
Returns
SignedUrlProvider
transfer
▸ transfer(options): Promise<FileTransfer>
Use this to send a file. Currently only supports sending files to another registered user. All registered endpoints of the target user will receive the file.
Parameters
| Name | Type | Description |
|---|---|---|
options | TransferOptions | transfer parameters |
Returns
Promise<FileTransfer>
a promise holding a FileTransfer object.