GroupApiClientInterface

Methods

changeGroupAvatarOrCover()

changeGroupAvatarOrCover(id, data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
id	string | number
data	FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCGroupType>

Source

services/group/index.ts:18

---

createGroup()

createGroup(data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
data	GroupCreateParams | FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCGroupType>

Source

services/group/index.ts:15

---

getGroupFeed()

getGroupFeed(id, params?, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
params?	GroupFeedParams
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/group/index.ts:14

---

getGroupInvitedUsers()

getGroupInvitedUsers(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/group/index.ts:23

---

getGroupMembers()

getGroupMembers(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/group/index.ts:19

---

getGroupSubscriptionStatus()

getGroupSubscriptionStatus(id, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/group/index.ts:27

---

getGroupSuggestedUsers()

getGroupSuggestedUsers(id, search, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
search	string
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/group/index.ts:20

---

getGroupWaitingApprovalSubscribers()

getGroupWaitingApprovalSubscribers(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/group/index.ts:28

---

getGroupsSuggestedUsers()

getGroupsSuggestedUsers(search, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
search	string
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/group/index.ts:21

---

getSpecificGroupInfo()

getSpecificGroupInfo(id, config?): Promise<SCGroupType>

Parameters

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

Returns

Promise<SCGroupType>

Source

services/group/index.ts:13

---

getUserGroups()

getUserGroups(params?, config?): Promise <SCPaginatedResponse<SCGroupType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCGroupType>>

Source

services/group/index.ts:10

---

getUserSubscribedGroups()

getUserSubscribedGroups(id, params?, config?): Promise <SCPaginatedResponse<SCGroupType>>

Parameters

Parameter	Type
id	string | number
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCGroupType>>

Source

services/group/index.ts:11

---

inviteOrAcceptGroupRequest()

inviteOrAcceptGroupRequest(id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
data	object
data.users	number[]
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/group/index.ts:26

---

patchGroup()

patchGroup(id, data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
id	string | number
data	SCGroupType
config?	AxiosRequestConfig<any>

Returns

Promise<SCGroupType>

Source

services/group/index.ts:17

---

removeUserFromGroup()

removeUserFromGroup(id, user, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/group/index.ts:22

---

searchGroups()

searchGroups(params?, config?): Promise <SCPaginatedResponse<SCGroupType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCGroupType>>

Source

services/group/index.ts:12

---

subscribeToGroup()

subscribeToGroup(id, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/group/index.ts:24

---

unsubscribeFromGroup()

unsubscribeFromGroup(id, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/group/index.ts:25

---

updateGroup()

updateGroup(id, data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
id	string | number
data	SCGroupType
config?	AxiosRequestConfig<any>

Returns

Promise<SCGroupType>

Source

services/group/index.ts:16