Class: TagService

services/tag.TagService

Tag service can be used in the following way:

1. Import the service from our library:

import {TagService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllTags` will return the paginated list of tags.

async getAllTags() {
       return await TagService.getAllTags();
     }

In case of required `params`, just add them inside the brackets.

async getSpecificTag(tagId) {
      return await TagService.getSpecificTag(tagId);
     }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

constructor

• new TagService(): TagService

Returns

TagService

Methods

assignATag

▸ assignATag(id, user?, category?, config?): Promise<SCTagType>

Parameters

Name	Type
id	string | number
user?	number
category?	number
config?	AxiosRequestConfig<any>

Returns

Promise<SCTagType>

Defined in

services/tag/index.ts:152

---

createTag

▸ createTag(data, config?): Promise<SCTagType>

Parameters

Name	Type
data	TagParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCTagType>

Defined in

services/tag/index.ts:137

---

getAllTags

▸ getAllTags(params?, config?): Promise<SCPaginatedResponse<SCTagType>>

Parameters

Name	Type
params?	TagGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCTagType>>

Defined in

services/tag/index.ts:134

---

getSpecificTag

▸ getSpecificTag(id, config?): Promise<SCTagType>

Parameters

Name	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCTagType>

Defined in

services/tag/index.ts:143

---

patchTag

▸ patchTag(id, data?, config?): Promise<SCTagType>

Parameters

Name	Type
id	string | number
data?	TagParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCTagType>

Defined in

services/tag/index.ts:149

---

searchTag

▸ searchTag(params?, config?): Promise<SCPaginatedResponse<SCTagType>>

Parameters

Name	Type
params?	TagGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCTagType>>

Defined in

services/tag/index.ts:140

---

updateTag

▸ updateTag(id, data?, config?): Promise<SCTagType>

Parameters

Name	Type
id	string | number
data?	TagParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCTagType>

Defined in

services/tag/index.ts:146