SpacesClient
@tribeplatform/gql-client / Modules / clients / SpacesClient
Class: SpacesClient#
clients.SpacesClient
Table of contents#
Constructors#
Methods#
Constructors#
constructor#
• new SpacesClient(client)
Parameters#
| Name | Type |
|---|---|
client | GraphqlClient |
Defined in#
packages/client/src/clients/spaces.client.ts:42
Methods#
create#
▸ create(variables, fields?, accessToken?): Promise<Space>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationCreateSpaceArgs | undefined |
fields | SpaceFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Space>
Defined in#
packages/client/src/clients/spaces.client.ts:46
delete#
▸ delete(variables, fields?, accessToken?): Promise<Action>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationDeleteSpaceArgs | undefined |
fields | ActionFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/spaces.client.ts:192
explore#
▸ explore(variables, fields?, accessToken?): Promise<PaginatedSpace>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryExploreSpacesArgs | undefined |
fields | PaginatedSpaceFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<PaginatedSpace>
Defined in#
packages/client/src/clients/spaces.client.ts:164
get#
▸ get(variables, fields?, accessToken?): Promise<Space>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QuerySpaceArgs | undefined |
fields | SpaceFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Space>
Defined in#
packages/client/src/clients/spaces.client.ts:102
join#
▸ join(variables): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationJoinSpaceArgs |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/spaces.client.ts:128
leave#
▸ leave(variables): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationLeaveSpaceArgs |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/spaces.client.ts:139
list#
▸ list(variables, fields, accessToken?): Promise<PaginatedSpace>
Parameters#
| Name | Type |
|---|---|
variables | QuerySpacesArgs |
fields | SpaceFields |
accessToken? | string |
Returns#
Promise<PaginatedSpace>
Defined in#
packages/client/src/clients/spaces.client.ts:60
listByIds#
▸ listByIds(variables, fields?, accessToken?): Promise<Space[]>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QuerySpacesByIdsArgs | undefined |
fields | SpaceFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Space[]>
Defined in#
packages/client/src/clients/spaces.client.ts:74
organize#
▸ organize(variables, fields?, accessToken?): Promise<Action>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationOrganizeSpacesInCollectionArgs | undefined |
fields | ActionFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/spaces.client.ts:88
pinnedPosts#
▸ pinnedPosts(variables, fields?, accessToken?): Promise<Post[]>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QuerySpacePinnedPostsArgs | undefined |
fields | PostFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Post[]>
Defined in#
packages/client/src/clients/spaces.client.ts:150
update#
▸ update(variables, fields?): Promise<Space>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationUpdateSpaceArgs | undefined |
fields | SpaceFields | 'basic' |
Returns#
Promise<Space>
Defined in#
packages/client/src/clients/spaces.client.ts:116
updateHighlightedTags#
▸ updateHighlightedTags(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationUpdateSpaceHighlightedTagsArgs |
accessToken? | string |
Returns#
Promise<Action>