@acceleratxr/core_sdk / UserLinkService
Class: UserLinkService#
Hierarchy#
-
↳ UserLinkService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new UserLinkService(apiClient: ApiClient, config: Configuration): UserLinkService
Overrides ServiceBase.constructor
Defined in src/services/UserLinkService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: UserLinkService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “44343ebc-2ce9-4f6a-8ea3-3cad67b0e051”
Defined in src/services/UserLinkService.ts:17
Methods#
clearMyLinks#
▸ clearMyLinks(): Promise<void>
Defined in src/services/UserLinkService.ts:104
Deletes all user links associated with the logged in user.
Returns: Promise<void>
count#
▸ count(query?: any): Promise<number>
Defined in src/services/UserLinkService.ts:46
Returns the count of links
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: UserLink): Promise<UserLink | undefined>
Defined in src/services/UserLinkService.ts:34
Create a new link.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<UserLink | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/UserLinkService.ts:91
Deletes the link
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<UserLink[] | undefined>
Defined in src/services/UserLinkService.ts:22
Returns all links from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<UserLink[] | undefined>
findById#
▸ findById(id: string): Promise<UserLink | undefined>
Defined in src/services/UserLinkService.ts:65
Returns a single link from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<UserLink | undefined>
findMyBlocked#
▸ findMyBlocked(): Promise<UserLink[] | undefined>
Defined in src/services/UserLinkService.ts:139
Retrieves a list of BLOCK links associated with the logged in user.
Returns: Promise<UserLink[] | undefined>
findMyFriends#
▸ findMyFriends(): Promise<UserLink[] | undefined>
Defined in src/services/UserLinkService.ts:158
Retrieves a list of FRIEND links associated with the logged in user.
Returns: Promise<UserLink[] | undefined>
findMyLinks#
▸ findMyLinks(): Promise<UserLink[] | undefined>
Defined in src/services/UserLinkService.ts:121
Retrieves a list of links associated with the logged in user.
Returns: Promise<UserLink[] | undefined>
findMySubscriptions#
▸ findMySubscriptions(): Promise<UserLink[] | undefined>
Defined in src/services/UserLinkService.ts:177
Retrieves a list of FOLLOW links associated with the logged in user.
Returns: Promise<UserLink[] | undefined>
setMyLinks#
▸ setMyLinks(links: UserLink[]): Promise<void>
Defined in src/services/UserLinkService.ts:196
Retrieves a list of FOLLOW links associated with the logged in user.
Parameters:#
Name |
Type |
|---|---|
|
UserLink[] |
Returns: Promise<void>
update#
▸ update(id: string, obj: UserLink): Promise<UserLink | undefined>
Defined in src/services/UserLinkService.ts:78
Updates a single link
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<UserLink | undefined>