Studio Service

Channel

Channel

The channel information.

FieldArgumentTypeDescription
nodeIdID!A globally unique identifier. Can be used in various places throughout the system to identify this single value.
idUUID!The uuid of the channel.
orgIdUUID!The uuid of the organization that channel belong to.
spaceIdUUIDThe uuid of the space that channel belong to.
nameString!The name of the channel.
widthIntThe height dimension of the channel.
heightIntThe width dimension of the channel.
layoutIdUUIDThe uuid reference to layout of the channel.
coverDataJSONThe channel cover icon detail include glyph and background color.
coverImageIdUUIDThe channel cover image file.
contentJSONThe information of the content structure in the channel.
tags[String]!
hiddenZoneBooleanToggle enable hidden zone for channel.
isHiddenBooleanTo identify the channel is the hidden channel from listing in the Channel page.
isPublishedBooleanTo identify the current channel's draft content has been published.
draftOfUUIDThe uuid of the published channel of this channel.
createdAtDatetime
updatedAtDatetime
publishedAtDatetime
createdByUUID
updatedByUUID
publishedByUUID
themeIdUUIDTheme for the channel.
useOrgDefaultTheme ⚠️Boolean

⚠️ DEPRECATED

The flag for telling that is the channel using the organization default theme.
typeChannelType!Indicate a type of the channel
isEmbedEnabledBooleanIndicate embed is enabled
isEmbedPublicBooleanIndicate embed is public
isSharedBoolean
isSharedExplicitBoolean
isSharedAllBoolean
orgByOrgIdOrgReads a single `Org` that is related to this `Channel`.
spaceBySpaceIdSpaceReads a single `Space` that is related to this `Channel`.
fileByCoverImageIdFileReads a single `File` that is related to this `Channel`.
channelByDraftOfChannelReads a single `Channel` that is related to this `Channel`.
userByCreatedByUserReads a single `User` that is related to this `Channel`.
userByUpdatedByUserReads a single `User` that is related to this `Channel`.
userByPublishedByUserReads a single `User` that is related to this `Channel`.
themeByThemeIdThemeReads a single `Theme` that is related to this `Channel`.
orgsByBlankChannelIdOrgsConnection!Reads and enables pagination through a set of `Org`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[OrgsOrderBy!]The method to use when ordering `Org`.
conditionOrgConditionA condition to be used in determining which values should be returned by the collection.
filterOrgFilterA filter to be used in determining which values should be returned by the collection.
orgsByBrandChannelIdOrgsConnection!Reads and enables pagination through a set of `Org`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[OrgsOrderBy!]The method to use when ordering `Org`.
conditionOrgConditionA condition to be used in determining which values should be returned by the collection.
filterOrgFilterA filter to be used in determining which values should be returned by the collection.
orgsByStartChannelIdOrgsConnection!Reads and enables pagination through a set of `Org`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[OrgsOrderBy!]The method to use when ordering `Org`.
conditionOrgConditionA condition to be used in determining which values should be returned by the collection.
filterOrgFilterA filter to be used in determining which values should be returned by the collection.
channelsByDraftOfChannelsConnection!Reads and enables pagination through a set of `Channel`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[ChannelsOrderBy!]The method to use when ordering `Channel`.
conditionChannelConditionA condition to be used in determining which values should be returned by the collection.
filterChannelFilterA filter to be used in determining which values should be returned by the collection.
associationsByFromChannelAndOrgIdAssociationsConnection!Reads and enables pagination through a set of `Association`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[AssociationsOrderBy!]The method to use when ordering `Association`.
conditionAssociationConditionA condition to be used in determining which values should be returned by the collection.
filterAssociationFilterA filter to be used in determining which values should be returned by the collection.
associationsByToChannelAndOrgIdAssociationsConnection!Reads and enables pagination through a set of `Association`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[AssociationsOrderBy!]The method to use when ordering `Association`.
conditionAssociationConditionA condition to be used in determining which values should be returned by the collection.
filterAssociationFilterA filter to be used in determining which values should be returned by the collection.
tagAssociationsByToChannelAndOrgIdTagAssociationsConnection!Reads and enables pagination through a set of `TagAssociation`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[TagAssociationsOrderBy!]The method to use when ordering `TagAssociation`.
conditionTagAssociationConditionA condition to be used in determining which values should be returned by the collection.
filterTagAssociationFilterA filter to be used in determining which values should be returned by the collection.
shareAssociationsByShareChannelShareAssociationsConnection!Reads and enables pagination through a set of `ShareAssociation`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[ShareAssociationsOrderBy!]The method to use when ordering `ShareAssociation`.
conditionShareAssociationConditionA condition to be used in determining which values should be returned by the collection.
filterShareAssociationFilterA filter to be used in determining which values should be returned by the collection.
shareAssociationsByShareChannelAndOrgIdShareAssociationsConnection!Reads and enables pagination through a set of `ShareAssociation`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[ShareAssociationsOrderBy!]The method to use when ordering `ShareAssociation`.
conditionShareAssociationConditionA condition to be used in determining which values should be returned by the collection.
filterShareAssociationFilterA filter to be used in determining which values should be returned by the collection.
screenContentHistoriesByChannelIdAndOrgIdScreenContentHistoriesConnection!Reads and enables pagination through a set of `ScreenContentHistory`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[ScreenContentHistoriesOrderBy!]The method to use when ordering `ScreenContentHistory`.
conditionScreenContentHistoryConditionA condition to be used in determining which values should be returned by the collection.
filterScreenContentHistoryFilterA filter to be used in determining which values should be returned by the collection.
embedsByChannelIdEmbedsConnection!Reads and enables pagination through a set of `Embed`.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
orderBy[EmbedsOrderBy!]The method to use when ordering `Embed`.
conditionEmbedConditionA condition to be used in determining which values should be returned by the collection.
filterEmbedFilterA filter to be used in determining which values should be returned by the collection.
appInstancesByChannelIdAppInstancesConnection!Get apps that contained in a channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
castedScreenByChannelIdScreensConnection!Get casted screen(s) by channel's id.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
channelsByChannelIdChannelsConnection!Get channel that contained in a channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
draftChannelHelper function for return draft version of a channel.
filesByChannelIdFilesConnection!Get files that contained in a channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
layoutByChannelLayout
linksByChannelIdLinksConnection!Get links that contained in a channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
playingScreenNumBigIntNumber of screens that currently playing the channel.
playlistsByChannelIdPlaylistsConnection!Get playlist that contained in a channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
publishedChannelHelper function for return published version of a channel.
screensByChannelIdScreensConnection!Screens that currently playing the channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
sharedSpacesByChannelIdSpacesConnection!Spaces that currently got shared access to the channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.
shortIdStringshortId for embeding
sitesByChannelIdSitesConnection!Get Sites that are contained in a channel.
firstIntOnly read the first `n` values of the set.
lastIntOnly read the last `n` values of the set.
offsetIntSkip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
beforeCursorRead all values in the set before (above) this cursor.
afterCursorRead all values in the set after (below) this cursor.