Class Contacts

Contacts

Date

2/1/2024 - 2:44:47 AM

Export

Index

Constructors

Properties

Methods

acceptRequest all block blocked deleteOutgoingRequest denyRequest incomingRequests incomingRequestsCount outgoingRequests remove sendRequest unblock

Constructors

constructor

new Contacts(params): Contacts
Creates an instance of Contacts.
Parameters
- params: ContactsConfig
Returns Contacts
Date
2/9/2024 - 5:54:11 AM
- Defined in src/contacts/index.ts:32

Properties

`Private` `Readonly` api

api: API

`Private` `Readonly` sdkConfig

sdkConfig: FilenSDKConfig

Methods

acceptRequest

acceptRequest(param0): Promise<void>
Accept incoming contact request.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 6:36:26 AM

Async
- Defined in src/contacts/index.ts:123

all

all(): Promise<Contact[]>
Fetch all contacts.

Returns Promise<Contact[]>
Date
2/20/2024 - 6:28:41 AM

Async
- Defined in src/contacts/index.ts:45

block

block(param0): Promise<void>
Block a user.
Parameters
- param0: {
  email: string;
  }
  - email: string
Returns Promise<void>
Date
2/20/2024 - 6:36:11 AM

Async
- Defined in src/contacts/index.ts:177

blocked

blocked(): Promise<BlockedContact[]>
Fetch all blocked contacts.

Returns Promise<BlockedContact[]>
Date
2/20/2024 - 6:34:55 AM

Async
- Defined in src/contacts/index.ts:163

deleteOutgoingRequest

deleteOutgoingRequest(param0): Promise<void>
Delete an outgoing contact request.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 6:36:39 AM

Async
- Defined in src/contacts/index.ts:95

denyRequest

denyRequest(param0): Promise<void>
Deny incoming contact request.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 6:36:17 AM

Async
- Defined in src/contacts/index.ts:137

incomingRequests

incomingRequests(): Promise<ContactRequest[]>
Fetch all incoming contact requests.

Returns Promise<ContactRequest[]>
Date
2/20/2024 - 6:29:43 AM

Async
- Defined in src/contacts/index.ts:57

incomingRequestsCount

incomingRequestsCount(): Promise<number>
Fetch count of all incoming contact requests.

Returns Promise<number>
Date
2/20/2024 - 6:30:11 AM

Async
- Defined in src/contacts/index.ts:69

outgoingRequests

outgoingRequests(): Promise<ContactRequest[]>
Fetch all outgoing contact requests.

Returns Promise<ContactRequest[]>
Date
2/20/2024 - 6:29:43 AM

Async
- Defined in src/contacts/index.ts:81

remove

remove(param0): Promise<void>
Remove a contact.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 6:34:24 AM

Async
- Defined in src/contacts/index.ts:151

sendRequest

sendRequest(param0): Promise<void>
Send a contact request.
Parameters
- param0: {
  email: string;
  }
  - email: string
Returns Promise<void>
Date
2/20/2024 - 6:36:33 AM

Async
- Defined in src/contacts/index.ts:109

unblock

unblock(param0): Promise<void>
Unblock a contact.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 6:36:05 AM

Async
- Defined in src/contacts/index.ts:191

Generated using TypeDoc