GraphQL API Reference
We provide all services that Talk can provide via the GraphQL API documented below. For a primer about GraphQL, visit http://graphql.org/.
If you’re already familiar with GraphQL, visit GraphQL API Overview to see how to interact with Talk’s GraphQL endpoint.
GraphQL Schema
Schema
Mutations
Creates a comment on the asset.
Creates a flag on an entity.
Creates a don't agree action on an entity.
Delete an action based on the action id.
Edit a comment
Sets the suspension status on a given user. Requires the MODERATOR role.
Mutation is restricted.
Sets the suspension status on a given user. Requires the MODERATOR role.
Mutation is restricted.
Sets the always premod status on a given user. Requires the MODERATOR role.
Mutation is restricted.
Sets the always premod status on a given user. Requires the MODERATOR role.
Mutation is restricted.
Sets the ban status on a given user. Requires the MODERATOR role.
Mutation is restricted.
Sets the ban status on a given user. Requires the MODERATOR role.
Mutation is restricted.
Sets the username status on a given user to APPROVED. Requires the
MODERATOR role. Mutation is restricted.
Sets the username status on a given user to REJECTED. Requires the
MODERATOR role. Mutation is restricted.
Changes the username to the desired username. Mutation is restricted to those users with permission do to so.
Sets the username to the desired username if the user has not had a chance to set their username. Mutation is restricted to those users with permission do to so that have not done so before.
Sets Comment status. Requires the ADMIN role.
Mutation is restricted.
Add a tag.
Removes a tag.
Set's a given users role to the one provided. If null is passed, the user
will not have any role.
Updates settings on a given asset. Mutation is restricted.
Updates the status of an asset allowing you to close/reopen an asset for commenting. Mutation is restricted.
closeAsset will close the asset for commenting based on server time.
updateSettings will update the global settings. Mutation is restricted.
Ignore comments by another user
CreateToken will create a token that is attached to the current user. Mutation is restricted.
RevokeToken will revoke an existing token. Mutation is restricted.
Stop Ignoring comments by another user.
forceScrapeAsset will force scrape the Asset with the given ID.
delUser will delete the user with the specified id.
changePassword allows the current user to change their password that have an associated local user account.
updateEmailAddress changes the email address of the current logged in user.
attachLocalAuth will attach a new local authentication profile to an account.
Creates a respect on an entity.
requestDownloadLink will request a download link be sent to the primary users email address.
requestAccountDeletion requests that the current account get deleted. The mutation will return the date that the account is scheduled to be deleted.
cancelAccountDeletion will cancel a pending account deletion that was previously scheduled.
downloadUser will provide an account download for the indicated User. This mutation requires the ADMIN role.
updateNotificationSettings will update the current user's notification settings.
Query
Site wide settings and defaults.
All assets. Requires the ADMIN role.
Comments returned based on a query.
Return the count of comments satisfied by the query. Note that this edge is
expensive as it is not batched. Requires the ADMIN role.
Return the count of users satisfied by the query. Note that this edge is expensive as it is not batched. This field is restricted.
The currently logged in user based on the request. Requires any logged in role.
Users returned based on a query. Requires the ADMIN role.
Object Types
Asset
Where comments are made on.
The current ID of the asset.
The scraped title of the asset.
The URL that the asset is located on.
The comments that are attached to the asset. When deep is true, the
comments returned will be at all depths.
The settings (rectified with the global settings) that should be applied to this asset.
The date that the asset was closed at.
True if asset is closed.
Summary of all Actions against all entities associated with the Asset.
(likes, flags, etc.). Requires the ADMIN role.
The date that the asset was created.
The tags on the asset
The author(s) of the asset.
AttachLocalAuthResponse
AttachLocalAuthResponse returns any errors for when the user attempts to attach a new local authentication profile.
An array of errors relating to the mutation that occurred.
CancelAccountDeletionResponse
CancelAccountDeletionResponse contains the account deletion errors relating to canceling an account deletion that was scheduled.
An array of errors relating to the mutation that occurred.
ChangePasswordResponse
An array of errors relating to the mutation that occurred.
ChangeUsernameResponse
An array of errors relating to the mutation that occurred.
CloseAssetResponse
CloseAssetResponse is the response returned with possibly some errors relating to the update status attempt.
An array of errors relating to the mutation that occurred.
Comment
The parent of the comment (if there is one).
The ID of the comment.
The actual comment data.
The body history of the comment. Requires the ADMIN or MODERATOR role or
the author.
The tags on the comment
The user who authored the comment.
The replies that were made to the comment.
replyCount is the number of replies with a depth of 1. Only direct replies to this comment are counted. Deleted comments are included in this count.
Actions completed on the parent. Requires the ADMIN role.
Action summaries against a comment.
The asset that a comment was made on.
The current status of a comment.
The status history of the comment. Requires the ADMIN or MODERATOR role.
The date that the comment was deleted at if it was.
The time when the comment was created
The time when the comment was updated.
describes how the comment can be edited
Indicates if it has a parent
url is the permalink to this particular Comment on the Asset.
CreateCommentResponse
CreateCommentResponse is returned with the comment that was created and any errors that may have occurred in the attempt to create it.
CreateDontAgreeResponse
CreateDontAgreeResponse is the response returned with possibly some errors relating to the creating the don't agree action attempt and possibly the don't agree that was created.
The don't agree that was created.
An array of errors relating to the mutation that occurred.
CreateFlagResponse
CreateFlagResponse is the response returned with possibly some errors relating to the creating the flag action attempt and possibly the flag that was created.
The flag that was created.
An array of errors relating to the mutation that occurred.
CreateRespectActionResponse
The respect that was created.
An array of errors relating to the mutation that occurred.
DefaultActionSummary
DefaultActionSummary is the ActionSummary provided for undefined types.
DefaultAssetActionSummary
DefaultAssetActionSummary is the AssetActionSummary provided for undefined types.
DefaultUserProfile
DefaultUserProfile is a fallback if the type of UserProfile can't be determined (like if it was from a plugin that was removed).
DeleteActionResponse
DeleteActionResponse is the response returned with possibly some errors relating to the delete action attempt.
An array of errors relating to the mutation that occurred.
DeleteRespectActionResponse
An array of errors relating to the mutation that occurred.
DelUserResponse
An array of errors relating to the mutation that occurred.
Domains
Domains describes all the available lists of domains.
whitelist is the list of domains that the embed is allowed to render on.
DontAgreeActionSummary
Summary for Don't Agree Action with a a unique reason.
The total count of flags with this reason.
The don't agree action by the current user against the parent entity with this reason.
DownloadUserResponse
DownloadUserResponse contains the account download archiveURL that can be used to directly download a zip file containing the user data.
EditCommentResponse
EditCommentResponse contains the updated comment and any errors that occurred.
FlagAction
A FLAG action that contains flag metadata.
The ID of the Flag Action.
The reason for which the Flag Action was created.
An optional message sent with the flagging action by the user.
The user who created the action.
The time when the Flag Action was updated.
The time when the Flag Action was created.
FlagActionSummary
Summary for Flag Action with a a unique reason.
The total count of flags with this reason.
The reason for which the Flag Action was created.
The flag by the current user against the parent entity with this reason.
ForceScrapeAssetResponse
An array of errors relating to the mutation that occurred.
GenericUserError
A generic error not related to validation reasons.
Translation key relating to a translatable string containing details to be displayed to the end user.
IgnoreUserResponse
Response to ignoreUser mutation
An array of errors relating to the mutation that occurred.
KarmaThreshold
KarmaThreshold defines the bounds for which a User will become unreliable or reliable based on their karma score. If the score is equal or less than the unreliable value, they are unreliable. If the score is equal or more than the reliable value, they are reliable. If they are neither reliable or unreliable then they are neutral.
KarmaThresholds
KarmaThresholds contains the currently set thresholds for triggering Trust beheviour.
flag represents karma settings in relation to how well a User's flagging ability aligns with the moderation decicions made by moderators.
comment represents the karma setting in relation to how well a User's comments are moderated.
LocalUserProfile
LocalUserProfile is for a User who has an authentication profile linked to their email address.
ModifyTagResponse
Response to the addTag or removeTag mutations.
An array of errors relating to the mutation that occurred.
NotificationSettings
Reliability
Reliability defines how a given user should be considered reliable for their comment or flag activity.
flagger will be true when the flagger is reliable, false if not, or
null if the reliability cannot be determined.
flaggerKarma will contains the number of agreed flags vs disagred flag count.
Commenter will be true when the commenter is reliable, false if not, or
null if the reliability cannot be determined.
commenterKarma the number of approved comments (not untouched) subtracted by the number of rejected comments.
RequestAccountDeletionResponse
RequestAccountDeletionResponse contains the account deletion schedule errors relating to schedulding an account for deletion.
scheduledDeletionDate is the data for which the user account will be deleted after. The account may be deleted up to half an hour after this date because the job responsible for deleting the scheduled account will only run once every half hour.
An array of errors relating to the mutation that occurred.
RequestDownloadLinkResponse
RequestDownloadLinkResponse contains the account download errors relating to the request for an account download.
An array of errors relating to the mutation that occurred.
RespectActionSummary
The count of actions with this group.
The current user's action.
RevokeTokenResponse
RevokeTokenResponse contains the errors related to revoking a token.
An array of errors relating to the mutation that occurred.
SetCommentStatusResponse
SetCommentStatusResponse is the response returned with possibly some errors relating to the delete action attempt.
An array of errors relating to the mutation that occurred.
Settings
moderation is the moderation mode for all Asset's on the site.
Enables a requirement for email confirmation before a user can login.
infoBoxEnable will enable the Info Box content visible above the question box.
infoBoxContent is the content of the Info Box.
questionBoxEnable will enable the Question Box's content to be visible above The comment box.
questionBoxContent is the content of the Question Box.
premodLinksEnable will put all comments that contain links into premod.
questionBoxIcon is the icon for the Question Box.
autoCloseStream when true will auto close the stream when the closeTimeout
amount of seconds have been reached.
customCssUrl is the URL of the custom CSS used to display on the frontend.
customAdminCssUrl is the URL of the custom CSS used to display on the admin panel.
closedTimeout is the amount of seconds from the created_at timestamp that a given asset will be considered closed.
closedMessage is the message shown to the user when the given Asset is closed.
disableCommenting will disable commenting site-wide.
disableCommentingMessage will be shown above the comment stream while commenting is disabled site-wide.
editCommentWindowLength is the length of time (in milliseconds) after a comment is posted that it can still be edited by the author.
charCountEnable is true when the character count restriction is enabled.
charCount is the maximum number of characters a comment may be.
organizationName is the name of the organization.
organizationContactEmail is the email of the organization.
wordlist will return a given list of words.
domains will return a given list of domains.
karmaThresholds contains the currently set thresholds for triggering Trust beheviour.
notificationsRequireConfirmation when true indicates that User's must have their email address confirmed/verified before they can receive notifications.
SetUsernameResponse
An array of errors relating to the mutation that occurred.
SetUsernameStatusResponse
An array of errors relating to the mutation that occurred.
SetUserRoleResponse
An array of errors relating to the mutation that occurred.
StopIgnoringUserResponse
Response to stopIgnoringUser mutation
An array of errors relating to the mutation that occurred.
Tag
Tag represents the underlying Tag that can be either stored in a global list or added uniquely to the entity.
TagLink
TagLink is used to associate a given Tag with a Model via a TagLink.
The underlying Tag that is either duplicated from the global list or created uniquely for this specific model.
The user that assigned the tag. This TagLink could have been created by the system, in which case this will be null. It could also be null if the current user is not an Admin/Moderator.
The date that the TagLink was created.
Token
Token is a personal access token associated with a given user.
ID is the unique identifier for the token.
Name is the description for the token.
Active determines if the token is available to hit the API.
JWT is the actual token to use for authentication, this is only available on token creation, otherwise it will be null.
UnsuspendUserResponse
UnsuspendUserResponse is the response returned with possibly some errors relating to the suspend action attempt.
An array of errors relating to the mutation that occurred.
UpdateAssetSettingsResponse
UpdateAssetSettingsResponse is the response returned with possibly some errors relating to the update settings attempt.
An array of errors relating to the mutation that occurred.
UpdateAssetStatusResponse
UpdateAssetStatusResponse is the response returned with possibly some errors relating to the update status attempt.
An array of errors relating to the mutation that occurred.
UpdateEmailAddressResponse
UpdateEmailAddressResponse is returned when you try to update a users email address.
An array of errors relating to the mutation that occurred.
UpdateNotificationSettingsResponse
An array of errors relating to the mutation that occurred.
UpdateSettingsResponse
UpdateSettingsResponse contains any errors that were rendered as a result of the mutation.
An array of errors relating to the mutation that occurred.
User
The ID of the User.
Username of a user.
creation date of user
Action summaries against the user.
Actions completed on the parent.
The current roles of the user.
The current profiles of the user.
The primary email address of the user. Only accessible to Administrators or the current user.
The tags on the user.
ignored users.
Tokens are the personal access tokens for a given user.
returns all comments based on a query.
reliable is the reference to a given user's Reliability. If the requesting user does not have permission to access the reliability, null will be returned.
returns user status
lastAccountDownload is the date that the user last requested a comment download.
scheduledDeletionDate is the data for which the user account will be deleted after. The account may be deleted up to half an hour after this date because the job responsible for deleting the scheduled account will only run once every half hour.
UserState
UserState describes the different permission based details for a user.
status describes the statuses of different aspects of the user's details.
UserStatus
username is the status of the username.
banned is the bool that determines if the user is banned or not.
alwaysPremod is the bool that determines if the user comments are always pushed to the premod queue or not
suspension is the date that the user is suspended until.
Input Types
AssetSettingsInput
Configurable settings that can be overridden for the Asset. You must specify all fields that should be updated.
| Arguments | |
|---|---|
| premodLinksEnable: Boolean | premodLinksEnable will put all comments that contain links into premod. |
| moderation: MODERATION_MODE | moderation is the moderation mode for the asset. |
| questionBoxEnable: Boolean | questionBoxEnable will enable the Question Boxs' content to be visible above The comment box. |
| questionBoxContent: String | questionBoxContent is the content of the Question Box. |
| questionBoxIcon: String | questionBoxIcon is the icon for the Question Box. |
AssetsQuery
AssetsQuery allows teh ability to query assets by specific fields
| Arguments | |
|---|---|
| value: String | a search string to match against titles, authors, urls, etc. |
| limit: Int | Limit the number of results to be returned |
| open: Boolean | open filters assets that are open/closed/all. Not providing this parameter will return all the assets, true will return assets that are open, and false will return assets that are closed. |
| sortOrder: SORT_ORDER | sortOrder specifies the order of the sort for the returned Assets. |
| cursor: Cursor | Skip results from the last created_at timestamp. |
AttachLocalAuthInput
AttachLocalAuthInput provides the input for attaching a new local authentication profile.
| Arguments | |
|---|---|
| email: String! | email is the Users email address that they want to add. |
| password: String! | password is the Users password that they want to add. |
ChangePasswordInput
| Arguments | |
|---|---|
| oldPassword: String! | oldPassword is the previous password set on the account. An incorrect password here will result in an unauthorized error being thrown. |
| newPassword: String! | newPassword is the password we're changing it to. |
CommentCountQuery
CommentCountQuery allows the ability to query comment counts by specific methods.
| Arguments | |
|---|---|
| statuses: [COMMENT_STATUS!] | Current status of a comment. This field is restricted. |
| asset_id: ID | Asset that a comment is on. |
| asset_url: String | The URL that the asset is located on. |
| parent_id: ID | The parent of the comment that we want to retrieve. |
| action_type: ACTION_TYPE | comments returned will only be ones which have at least one action of this type. |
| author_id: ID | author_id allows the querying of comment counts based on the author of the comments. |
| tags: [String!] | Filter by a specific tag name. |
| excludeDeleted: Boolean | excludeDeleted when true will exclude deleted comments from the count. |
CommentsQuery
CommentsQuery allows the ability to query comments by a specific methods.
| Arguments | |
|---|---|
| author_id: ID | Author of the comments. |
| statuses: [COMMENT_STATUS!] | Current status of a comment. This field is restricted. |
| asset_id: ID | Asset that a comment is on. |
| parent_id: ID | The parent of the comment that we want to retrieve. |
| action_type: ACTION_TYPE | Comments returned will only be ones which have at least one action of this
type. Requires the |
| limit: Int | Limit the number of results to be returned. |
| cursor: Cursor | Skip results from the last created_at timestamp. |
| sortOrder: SORT_ORDER | Sort the results by from largest first. |
| sortBy: SORT_COMMENTS_BY | The order to sort the comments by, sorting by default the created at timestamp. |
| tags: [String!] | Filter by a specific tag name. |
| excludeIgnored: Boolean | Exclude comments ignored by the requesting user |
| excludeDeleted: Boolean | excludeDeleted when true will exclude deleted comments from the response. |
CreateCommentInput
| Arguments | |
|---|---|
| asset_id: ID! | The asset id |
| parent_id: ID | The id of the parent comment |
| body: String! | The body of the comment |
| tags: [String] | Tags |
CreateDontAgreeInput
| Arguments | |
|---|---|
| item_id: ID! | The item's id for which we are to create a don't agree. |
| item_type: ACTION_ITEM_TYPE! | The type of the item for which we are to create the don't agree. |
| message: String | An optional message sent with the don't agree action by the user. |
CreateFlagInput
| Arguments | |
|---|---|
| item_id: ID! | The item's id for which we are to create a flag. |
| item_type: ACTION_ITEM_TYPE! | The type of the item for which we are to create the flag. |
| reason: FLAG_REASON | The reason for flagging the item. |
| message: String | An optional message sent with the flagging action by the user. |
CreateRespectActionInput
| Arguments | |
|---|---|
| item_id: ID! | The item's id for which we are to create a respect. |
CreateTokenInput
CreateTokenInput contains the input to create the token.
| Arguments | |
|---|---|
| name: String! | Name is the description for the token. |
DeleteRespectActionInput
| Arguments | |
|---|---|
| id: ID! | The item's id for which we are deleting a respect. |
EditCommentInput
| Arguments | |
|---|---|
| body: String! | Update body of the comment |
ModifyTagInput
ModifyTagInput is the input used to modify a tag.
| Arguments | |
|---|---|
| name: String! | name is the actual tag to add to the model. |
| id: ID! | id is the ID of the model in question that we are modifying the tag of. |
| item_type: TAGGABLE_ITEM_TYPE! | item_type is the type of item that we are modifying the tag if. |
| asset_id: ID | asset_id is used when the item_type is |
NotificationSettingsInput
| Arguments | |
|---|---|
| digestFrequency: DIGEST_FREQUENCY | digestFrequency is the frequency to send notifications. |
RepliesQuery
| Arguments | |
|---|---|
| sortOrder: SORT_ORDER | Sort the results by from smallest first. |
| sortBy: SORT_COMMENTS_BY | The order to sort the comments by, sorting by default the created at timestamp. |
| limit: Int | Limit the number of results to be returned. |
| excludeIgnored: Boolean | Exclude comments ignored by the requesting user |
| excludeDeleted: Boolean | excludeDeleted when true will exclude deleted comments from the response. |
RevokeTokenInput
RevokeTokenInput contains the input to revoke the token.
| Arguments | |
|---|---|
| id: ID! | ID is the JTI for the token. |
UpdateAssetStatusInput
UpdateAssetStatusInput contains the input to change the status of a comment as it relates to being open/closed for commenting.
| Arguments | |
|---|---|
| closedAt: Date | closedAt is the time that the asset will be closed for commenting. If this is null or in the future, it will be open for commenting. |
| closedMessage: String | closedMessage is the message to be set on the asset when it is closed. If it
is null, then the message will default to the globally set |
UpdateDomainsInput
UpdateDomainsInput describes all the available lists of domains.
| Arguments | |
|---|---|
| whitelist: [String!] | whitelist is the list of domains that the embed is allowed to render on. |
UpdateEmailAddressInput
UpdateEmailAddressInput provides input for changing a users email address associated with their account.
| Arguments | |
|---|---|
| email: String! | email is the Users email address that they want to update to. |
| confirmPassword: String! | confirmPassword is the Users current password. |
UpdateSettingsInput
UpdateSettingsInput is the input used to input the global site settings. This will override the existing settings, so all fields must be included.
| Arguments | |
|---|---|
| moderation: MODERATION_MODE | moderation is the moderation mode for all Asset's on the site. |
| requireEmailConfirmation: Boolean | Enables a requirement for email confirmation before a user can login. |
| infoBoxEnable: Boolean | infoBoxEnable will enable the Info Box content visible above the question box. |
| infoBoxContent: String | infoBoxContent is the content of the Info Box. |
| questionBoxEnable: Boolean | questionBoxEnable will enable the Question Box's content to be visible above The comment box. |
| questionBoxContent: String | questionBoxContent is the content of the Question Box. |
| premodLinksEnable: Boolean | premodLinksEnable will put all comments that contain links into premod. |
| questionBoxIcon: String | questionBoxIcon is the icon for the Question Box. |
| autoCloseStream: Boolean | autoCloseStream when true will auto close the stream when the |
| customCssUrl: String | customCssUrl is the URL of the custom CSS used to display on the frontend. |
| customAdminCssUrl: String | customAdminCssUrl is the URL of the custom CSS used to display on the admin panel. |
| closedTimeout: Int | closedTimeout is the amount of seconds from the created_at timestamp that a given asset will be considered closed. |
| closedMessage: String | closedMessage is the message shown to the user when the given Asset is closed. |
| disableCommenting: Boolean | disableCommenting will disable commenting site-wide. |
| disableCommentingMessage: String | disableCommentingMessage will be shown above the comment stream while commenting is disabled site-wide. |
| charCountEnable: Boolean | charCountEnable is true when the character count restriction is enabled. |
| charCount: Int | charCount is the maximum number of characters a comment may be. |
| organizationName: String | organizationName is the name of the organization. |
| organizationContactEmail: String | organizationContactEmail is the email of the organization. |
| editCommentWindowLength: Int | editCommentWindowLength is the length of time (in milliseconds) after a comment is posted that it can still be edited by the author. |
| wordlist: UpdateWordlistInput | wordlist allows changing the available wordlists. |
| domains: UpdateDomainsInput | domains allows changing the available lists of domains. |
UpdateWordlistInput
UpdateWordlistInput is the list of words that composes the Wordlist.
| Arguments | |
|---|---|
| banned: [String!] | banned words will by default reject the comment if it is found. |
| suspect: [String!] | suspect words will simply flag the comment. |
UserCountQuery
UserCountQuery allows the ability to query user counts by specific methods.
| Arguments | |
|---|---|
| action_type: ACTION_TYPE | comments returned will only be ones which have at least one action of this type. |
| state: UserStateInput | state queries for a specific subset of users with the given state query. |
UsersQuery
UsersQuery allows the ability to query users by a specific fields.
| Arguments | |
|---|---|
| action_type: ACTION_TYPE | Users returned will only be ones which have at least one action of this. |
| state: UserStateInput | state will filter the users to a specific set of users that meet. |
| value: String | value is the search string to use to search for a pa |
| limit: Int | Limit the number of results to be returned. |
| cursor: Cursor | Skip results from the last created_at timestamp. |
| sortOrder: SORT_ORDER | Sort the results by created_at. |
UserStatusInput
UserStatusInput describes the queryable components of the UserStatus.
| Arguments | |
|---|---|
| username: [USER_STATUS_USERNAME!] | username will restrict the returned users to only those with the given username status's. If not provided, no filtering will be performed. |
| banned: Boolean | banned will restrict the returned users to only those that are, or are not banned. If not provided, no filtering will be performed. |
| suspended: Boolean | suspended will restrict the returned users to only those that are, or are not suspended. If not provided, no filtering will be performed. |
| alwaysPremod: Boolean | alwaysPremod will restrict the returned users to only those that are, or are not marked as always premoderate. If not provided, no filtering will be performed. |
Interfaces
Response
Response defines what can be expected from any response to a mutation action.
- CreateCommentResponse
- CreateFlagResponse
- CreateDontAgreeResponse
- DeleteActionResponse
- EditCommentResponse
- SuspendUserResponse
- UnsuspendUserResponse
- AlwaysPremodUserResponse
- RemoveAlwaysPremodUserResponse
- BanUsersResponse
- UnbanUserResponse
- SetUsernameStatusResponse
- ChangeUsernameResponse
- SetUsernameResponse
- SetCommentStatusResponse
- ModifyTagResponse
- SetUserRoleResponse
- UpdateAssetSettingsResponse
- UpdateAssetStatusResponse
- CloseAssetResponse
- UpdateSettingsResponse
- IgnoreUserResponse
- CreateTokenResponse
- RevokeTokenResponse
- StopIgnoringUserResponse
- ForceScrapeAssetResponse
- DelUserResponse
- ChangePasswordResponse
- UpdateEmailAddressResponse
- AttachLocalAuthResponse
- CreateRespectActionResponse
- DeleteRespectActionResponse
- RequestDownloadLinkResponse
- RequestAccountDeletionResponse
- CancelAccountDeletionResponse
- DownloadUserResponse
- UpdateNotificationSettingsResponse
An array of errors relating to the mutation that occurred.
UserError
Any error rendered due to the user's input.
Translation key relating to a translatable string containing details to be displayed to the end user.
Enums
ACTION_ITEM_TYPE
Used to represent the item type for an action.
| ASSETS | The action references a entity of type Asset. |
| COMMENTS | The action references a entity of type Comment. |
| USERS | The action references a entity of type User. |
ACTION_TYPE
| FLAG | Represents a FlagAction. |
| DONTAGREE | Represents a don't agree action |
| RESPECT | Represents a Respect. |
COMMENT_STATUS
The statuses that a comment may have.
| NONE | The comment is not PREMOD, but was not applied a moderation status by a moderator. |
| ACCEPTED | The comment has been accepted by a moderator. |
| REJECTED | The comment has been rejected by a moderator. |
| PREMOD | The comment was created while the asset's premoderation option was on, and new comments that haven't been moderated yet are referred to as "premoderated" or "premod" comments. |
| SYSTEM_WITHHELD | SYSTEM_WITHHELD represents a comment that was withheld by the system because it was flagged by an internal process for further review. |
DIGEST_FREQUENCY
| NONE | NONE will have the notifications send immediatly rather than bundling for digesting. |
| HOURLY | HOURLY will queue up the notifications and send them hourly. |
| DAILY | DAILY will queue up the notifications and send them daily. |
FLAG_REASON
| USERNAME_OFFENSIVE | The current user thinks that the flagged username is offensive. |
| USERNAME_NOLIKE | The current user does not like the flagged username. |
| USERNAME_IMPERSONATING | The current user thinks that the flagged username is being used to impersonate another user. |
| USERNAME_SPAM | The current user thinks that the flagged username is spam. |
| USERNAME_OTHER | The current user thinks that the flagged username is wrong for another reason. |
| COMMENT_OFFENSIVE | The current user thinks that the flagged comment is offensive. |
| COMMENT_SPAM | The current user thinks that the flagged comment is spam. |
| COMMENT_OTHER | The current user thinks that the flagged comment is wrong for another reason. |
MODERATION_MODE
The moderation mode of the site.
| PRE | Comments posted while in |
| POST | Comments posted while in |
SORT_COMMENTS_BY
| CREATED_AT | Comments will be sorted by their created at date. |
| REPLIES | Comments will be sorted by their immediate reply count (replies to the comment in question only, not including descendants). |
| RESPECTS | Comments will be sorted by their count of respects on the comment. |
SORT_ORDER
Establishes the ordering of the content by their created_at time stamp.
| DESC | newest to oldest order. |
| ASC | oldest to newer order. |
TAGGABLE_ITEM_TYPE
Used to represent the item type for a tag.
| ASSETS | The action references a entity of type Asset. |
| COMMENTS | The action references a entity of type Comment. |
| USERS | The action references a entity of type User. |
USER_ROLES
Roles that a user can have, these can be combined.
| ADMIN | an administrator of the site |
| MODERATOR | a moderator of the site |
| STAFF | a staff of the site |
| COMMENTER | a user without administrative roles. |
USER_STATUS_USERNAME
USER_STATUS_USERNAME is the different states that a username can be in.
| UNSET | UNSET is used when the username can be changed, and does not necessarily require moderator action to become active. This can be used when the user signs up with a social login and has the option of setting their own username. |
| SET | SET is used when the username has been set for the first time, but cannot change without the username being rejected by a moderator and that moderator agreeing that the username should be allowed to change. |
| APPROVED | APPROVED is used when the username was changed, and subsequently approved by said moderator. |
| REJECTED | REJECTED is used when the username was changed, and subsequently rejected by said moderator. |
| CHANGED | CHANGED is used after a user has changed their username after it was rejected. |
Scalars
ID
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.