@tribeplatform/gql-client / Modules / client / TribeClient

Class: TribeClient

client.TribeClient

Table of contents

Constructors

• constructor

Properties

• app
• auth
• billing
• collections
• dev
• invitations
• media
• members
• moderation
• network
• notifications
• pages
• posts
• report
• roles
• slates
• spaceMembers
• spaceMembership
• spacePostType
• spaceRoles
• spaces
• tags
• theme

Methods

• generateToken
• getLimitedToken
• getTokens
• search
• setToken

Constructors

constructor

• new TribeClient(options)

Parameters

Name	Type
options	TribeClientOptions

Defined in

packages/client/src/client.ts:95

Properties

app

• app: AppClient

Defined in

packages/client/src/client.ts:47

---

auth

• auth: AuthClient

Defined in

packages/client/src/client.ts:49

---

billing

• billing: BillingClient

Defined in

packages/client/src/client.ts:51

---

collections

• collections: CollectionsClient

Defined in

packages/client/src/client.ts:53

---

dev

• dev: DevClient

Defined in

packages/client/src/client.ts:55

---

invitations

• invitations: InvitationsClient

Defined in

packages/client/src/client.ts:57

---

media

• media: MediaClient

Defined in

packages/client/src/client.ts:59

---

members

• members: MembersClient

Defined in

packages/client/src/client.ts:61

---

moderation

• moderation: ModerationClient

Defined in

packages/client/src/client.ts:63

---

network

• network: NetworkClient

Defined in

packages/client/src/client.ts:65

---

notifications

• notifications: NotificationsClient

Defined in

packages/client/src/client.ts:67

---

pages

• pages: PagesClient

Defined in

packages/client/src/client.ts:91

---

posts

• posts: PostsClient

Defined in

packages/client/src/client.ts:69

---

report

• report: ReportClient

Defined in

packages/client/src/client.ts:71

---

roles

• roles: RolesClient

Defined in

packages/client/src/client.ts:73

---

slates

• slates: SlatesClient

Defined in

packages/client/src/client.ts:89

---

spaceMembers

• spaceMembers: SpaceMembersClient

Defined in

packages/client/src/client.ts:75

---

spaceMembership

• spaceMembership: SpaceMembershipClient

Defined in

packages/client/src/client.ts:77

---

spacePostType

• spacePostType: SpacePostTypeClient

Defined in

packages/client/src/client.ts:83

---

spaceRoles

• spaceRoles: SpaceRolesClient

Defined in

packages/client/src/client.ts:79

---

spaces

• spaces: SpacesClient

Defined in

packages/client/src/client.ts:81

---

tags

• tags: TagsClient

Defined in

packages/client/src/client.ts:85

---

theme

• theme: ThemeClient

Defined in

packages/client/src/client.ts:87

Methods

generateToken

▸ generateToken(options): Promise<string>

Parameters

Name	Type
options	Object
options.memberId?	string
options.networkId	string

Returns

Promise<string>

Defined in

packages/client/src/client.ts:176

---

getLimitedToken

▸ getLimitedToken(variables, fields?, useBasicToken?): Promise<AppToken>

Parameters

Name	Type	Default value
variables	QueryLimitedTokenArgs	undefined
fields	LimitedTokenFields	'basic'
useBasicToken?	boolean	undefined

Returns

Promise<AppToken>

Defined in

packages/client/src/client.ts:148

---

getTokens

▸ getTokens(variables, fields?): Promise<AuthToken>

Get the guest access token for a community.

query tokens(): AuthToken!

example

t.client.getTokens({networkDomain: 'community.tribe.so'})

Parameters

Name	Type	Default value
variables	QueryTokensArgs	undefined
fields	AuthTokenFields	'default'

Returns

Promise<AuthToken>

The AuthToken.

Defined in

packages/client/src/client.ts:136

---

search

▸ search(variables, fields?, accessToken?): Promise<SearchResult>

Parameters

Name	Type	Default value
variables	QuerySearchArgs	undefined
fields	SearchEntityFields	'basic'
accessToken?	string	undefined

Returns

Promise<SearchResult>

Defined in

packages/client/src/client.ts:162

---

setToken

▸ setToken(accessToken): void

Parameters

Name	Type
accessToken	string

Returns

void

Defined in

packages/client/src/client.ts:123