@tribeplatform/gql-client / Modules / clients / PostsClient

Class: PostsClient

clients.PostsClient

Table of contents

Constructors

• constructor

Methods

• addReaction
• byMember
• create
• delete
• feed
• get
• getPostType
• hide
• list
• listPostTypes
• pinToSpace
• reactionParticipants
• removeReaction
• replies
• reply
• unhide
• unpinFromSpace
• update

Constructors

constructor

• new PostsClient(client)

Parameters

Name	Type
client	GraphqlClient

Defined in

packages/client/src/clients/posts.client.ts:59

Methods

addReaction

▸ addReaction(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationAddReactionArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/posts.client.ts:206

---

byMember

▸ byMember(memberId, variables?, fields?, accessToken?): Promise<PaginatedPost>

Parameters

Name	Type	Default value
memberId	string	undefined
variables	Omit<QueryMemberPostsArgs, "memberId">	undefined
fields	PostFields	'basic'
accessToken?	string	undefined

Returns

Promise<PaginatedPost>

Defined in

packages/client/src/clients/posts.client.ts:174

---

create

▸ create(variables, fields?, accessToken?): Promise<Post>

Parameters

Name	Type	Default value
variables	MutationCreatePostArgs	undefined
fields	PostFields	'basic'
accessToken?	string	undefined

Returns

Promise<Post>

Defined in

packages/client/src/clients/posts.client.ts:89

---

delete

▸ delete(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationDeletePostArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/posts.client.ts:261

---

feed

▸ feed(variables?, fields?, accessToken?): Promise<PaginatedPost>

Parameters

Name	Type	Default value
variables	QueryFeedArgs	undefined
fields	PostFields	'basic'
accessToken?	string	undefined

Returns

Promise<PaginatedPost>

Defined in

packages/client/src/clients/posts.client.ts:142

---

get

▸ get(id, fields?, accessToken?): Promise<Post>

Parameters

Name	Type	Default value
id	string	undefined
fields	PostFields	'basic'
accessToken?	string	undefined

Returns

Promise<Post>

Defined in

packages/client/src/clients/posts.client.ts:128

---

getPostType

▸ getPostType(id, fields?): Promise<PostType>

Parameters

Name	Type	Default value
id	string	undefined
fields	PostTypeFields	'basic'

Returns

Promise<PostType>

Defined in

packages/client/src/clients/posts.client.ts:77

---

hide

▸ hide(variables, accessToken?): Promise<Action>

Parameters

Name	Type
variables	MutationHidePostArgs
accessToken?	string

Returns

Promise<Action>

Defined in

packages/client/src/clients/posts.client.ts:235

---

list

▸ list(variables, fields?, accessToken?): Promise<PaginatedPost>

Parameters

Name	Type	Default value
variables	QueryGetPostsArgs | QueryTagPostsArgs	undefined
fields	PostFields	'basic'
accessToken?	string	undefined

Returns

Promise<PaginatedPost>

Defined in

packages/client/src/clients/posts.client.ts:103

---

listPostTypes

▸ listPostTypes(variables, fields?, customToken?): Promise<PaginatedPostType>

Parameters

Name	Type	Default value
variables	QueryPostTypesArgs	undefined
fields	PostTypeFields	'basic'
customToken?	string	undefined

Returns

Promise<PaginatedPostType>

Defined in

packages/client/src/clients/posts.client.ts:63

---

pinToSpace

▸ pinToSpace(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationPinPostToSpaceArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/posts.client.ts:289

---

reactionParticipants

▸ reactionParticipants(variables, fields?, accessToken?): Promise<PaginatedPostReactionParticipant>

Parameters

Name	Type	Default value
variables	QueryPostReactionParticipantsArgs	undefined
fields	MemberFields	'basic'
accessToken?	string	undefined

Returns

Promise<PaginatedPostReactionParticipant>

Defined in

packages/client/src/clients/posts.client.ts:317

---

removeReaction

▸ removeReaction(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationRemoveReactionArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/posts.client.ts:221

---

replies

▸ replies(variables, fields?): Promise<PaginatedPost>

Parameters

Name	Type	Default value
variables	QueryRepliesArgs	undefined
fields	PostFields	'basic'

Returns

Promise<PaginatedPost>

Defined in

packages/client/src/clients/posts.client.ts:192

---

reply

▸ reply(postId, variables, fields?, accessToken?): Promise<Post>

Parameters

Name	Type	Default value
postId	string	undefined
variables	Omit<MutationCreateReplyArgs, "postId">	undefined
fields	PostFields	'basic'
accessToken?	string	undefined

Returns

Promise<Post>

Defined in

packages/client/src/clients/posts.client.ts:156

---

unhide

▸ unhide(variables, accessToken?): Promise<Action>

Parameters

Name	Type
variables	MutationUnhidePostArgs
accessToken?	string

Returns

Promise<Action>

Defined in

packages/client/src/clients/posts.client.ts:248

---

unpinFromSpace

▸ unpinFromSpace(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationUnpinPostFromSpaceArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/posts.client.ts:303

---

update

▸ update(variables, fields?, accessToken?): Promise<Post>

Parameters

Name	Type	Default value
variables	MutationUpdatePostArgs	undefined
fields	PostFields	'basic'
accessToken?	string	undefined

Returns

Promise<Post>

Defined in

packages/client/src/clients/posts.client.ts:275