AppClient
@tribeplatform/gql-client / Modules / clients / AppClient
Class: AppClient#
clients.AppClient
Table of contents#
Constructors#
Methods#
Constructors#
constructor#
• new AppClient(client)
Parameters#
| Name | Type |
|---|---|
client | GraphqlClient |
Defined in#
packages/client/src/clients/app.client.ts:33
Methods#
appInstallations#
▸ appInstallations(variables, fields?, accessToken?): Promise<PaginatedAppInstallation>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryGetNetworkAppInstallationsArgs | undefined |
fields | AppInstallationFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<PaginatedAppInstallation>
Defined in#
packages/client/src/clients/app.client.ts:132
get#
▸ get(variables, fields?, accessToken?): Promise<App>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryAppArgs | undefined |
fields | AppFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<App>
Defined in#
packages/client/src/clients/app.client.ts:37
install#
▸ install(variables, fields?, accessToken?): Promise<AppInstallation>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationInstallAppArgs | undefined |
fields | AppInstallationFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<AppInstallation>
Defined in#
packages/client/src/clients/app.client.ts:104
list#
▸ list(variables, fields?, accessToken?): Promise<PaginatedApp>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryAppsArgs | undefined |
fields | AppFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<PaginatedApp>
Defined in#
packages/client/src/clients/app.client.ts:51
networkSettings#
▸ networkSettings(variables, accessToken?): Promise<string>
Parameters#
| Name | Type |
|---|---|
variables | QueryGetAppNetworkSettingsArgs |
accessToken? | string |
Returns#
Promise<string>
Defined in#
packages/client/src/clients/app.client.ts:65
spaceSettings#
▸ spaceSettings(variables, accessToken?): Promise<string>
Parameters#
| Name | Type |
|---|---|
variables | QueryGetAppSpaceSettingsArgs |
accessToken? | string |
Returns#
Promise<string>
Defined in#
packages/client/src/clients/app.client.ts:91
uninstall#
▸ uninstall(variables, fields?, accessToken?): Promise<AppInstallation>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationUninstallAppArgs | undefined |
fields | AppInstallationFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<AppInstallation>
Defined in#
packages/client/src/clients/app.client.ts:118
updateNetworkSettings#
▸ updateNetworkSettings(variables, accessToken?): Promise<AppAction>
Parameters#
| Name | Type |
|---|---|
variables | MutationUpdateAppNetworkSettingsArgs |
accessToken? | string |
Returns#
Promise<AppAction>