DiscussionApi
extends AbstractApi
in package
Project discussions and their replies. Crowdin only.
Table of Contents
Methods
- create() : Discussion|null
- Add Project Discussion
- createReply() : DiscussionReply|null
- Add Discussion Reply
- delete() : mixed
- Delete Project Discussion
- deleteReply() : mixed
- Delete Discussion Reply
- get() : Discussion|null
- Get Project Discussion
- getReply() : DiscussionReply|null
- Get Discussion Reply
- list() : ModelCollection
- List Project Discussions
- listReplies() : ModelCollection
- List Discussion Replies
- update() : Discussion|null
- Edit Project Discussion
- updateReply() : DiscussionReply|null
- Edit Discussion Reply
Methods
create()
Add Project Discussion
public
create(int $projectId, array<string|int, mixed> $data) : Discussion|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[title] required
string $data[text] required. Markdown, posted as the first reply
string $data[languageId] Omit for a discussion about all languages
Tags
Return values
Discussion|nullcreateReply()
Add Discussion Reply
public
createReply(int $projectId, int $discussionId, array<string|int, mixed> $data) : DiscussionReply|null
Parameters
- $projectId : int
- $discussionId : int
- $data : array<string|int, mixed>
-
string $data[text] required. Markdown
Tags
Return values
DiscussionReply|nulldelete()
Delete Project Discussion
public
delete(int $projectId, int $discussionId) : mixed
Parameters
- $projectId : int
- $discussionId : int
Tags
deleteReply()
Delete Discussion Reply
public
deleteReply(int $projectId, int $discussionId, int $replyId) : mixed
Parameters
- $projectId : int
- $discussionId : int
- $replyId : int
Tags
get()
Get Project Discussion
public
get(int $projectId, int $discussionId) : Discussion|null
Parameters
- $projectId : int
- $discussionId : int
Tags
Return values
Discussion|nullgetReply()
Get Discussion Reply
public
getReply(int $projectId, int $discussionId, int $replyId) : DiscussionReply|null
Parameters
- $projectId : int
- $discussionId : int
- $replyId : int
Tags
Return values
DiscussionReply|nulllist()
List Project Discussions
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
string $params[status] open, closed or comma-separated list. Default is open
string $params[userIds] One ID or comma-separated list
string $params[languageIds] One ID or comma-separated list
string $params[search] Title, description or reply text
string $params[orderBy] id, title, createdAt, updatedAt or repliesCount. Default is updatedAt desc
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistReplies()
List Discussion Replies
public
listReplies(int $projectId, int $discussionId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $discussionId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Project Discussion
public
update(int $projectId, Discussion $discussion) : Discussion|null
Parameters
- $projectId : int
- $discussion : Discussion
-
Only title, status and isMuted can be changed
Tags
Return values
Discussion|nullupdateReply()
Edit Discussion Reply
public
updateReply(int $projectId, DiscussionReply $reply) : DiscussionReply|null
Parameters
- $projectId : int
- $reply : DiscussionReply
-
Only text can be changed