Channel
Channel
The channel information.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodeId | ID! | A globally unique identifier. Can be used in various places throughout the system to identify this single value. | |
| id | UUID! | The uuid of the channel. | |
| orgId | UUID! | The uuid of the organization that channel belong to. | |
| spaceId | UUID | The uuid of the space that channel belong to. | |
| name | String! | The name of the channel. | |
| width | Int | The height dimension of the channel. | |
| height | Int | The width dimension of the channel. | |
| layoutId | UUID | The uuid reference to layout of the channel. | |
| coverData | JSON | The channel cover icon detail include glyph and background color. | |
| coverImageId | UUID | The channel cover image file. | |
| content | JSON | The information of the content structure in the channel. | |
| tags | [String]! | ||
| hiddenZone | Boolean | Toggle enable hidden zone for channel. | |
| isHidden | Boolean | To identify the channel is the hidden channel from listing in the Channel page. | |
| isPublished | Boolean | To identify the current channel's draft content has been published. | |
| draftOf | UUID | The uuid of the published channel of this channel. | |
| createdAt | Datetime | ||
| updatedAt | Datetime | ||
| publishedAt | Datetime | ||
| createdBy | UUID | ||
| updatedBy | UUID | ||
| publishedBy | UUID | ||
| themeId | UUID | Theme for the channel. | |
| useOrgDefaultTheme ⚠️ | Boolean | ⚠️ DEPRECATED The flag for telling that is the channel using the organization default theme. | |
| type | ChannelType! | Indicate a type of the channel | |
| isEmbedEnabled | Boolean | Indicate embed is enabled | |
| isEmbedPublic | Boolean | Indicate embed is public | |
| isShared | Boolean | ||
| isSharedExplicit | Boolean | ||
| isSharedAll | Boolean | ||
| isEnabled | Boolean | ||
| childOf | UUID | ||
| preferences | JSON | ||
| duplicateOf | UUID | ||
| orgByOrgId | Org | Reads a single `Org` that is related to this `Channel`. | |
| spaceBySpaceId | Space | Reads a single `Space` that is related to this `Channel`. | |
| fileByCoverImageId | File | Reads a single `File` that is related to this `Channel`. | |
| channelByDraftOf | Channel | Reads a single `Channel` that is related to this `Channel`. | |
| userByCreatedBy | User | Reads a single `User` that is related to this `Channel`. | |
| userByUpdatedBy | User | Reads a single `User` that is related to this `Channel`. | |
| userByPublishedBy | User | Reads a single `User` that is related to this `Channel`. | |
| themeByThemeId | Theme | Reads a single `Theme` that is related to this `Channel`. | |
| channelByChildOf | Channel | Reads a single `Channel` that is related to this `Channel`. | |
| channelByDuplicateOf | Channel | Reads a single `Channel` that is related to this `Channel`. | |
| orgsByBlankChannelId | OrgsConnection! | Reads and enables pagination through a set of `Org`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [OrgsOrderBy!] | The method to use when ordering `Org`. | |
| condition | OrgCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | OrgFilter | A filter to be used in determining which values should be returned by the collection. | |
| orgsByBrandChannelId | OrgsConnection! | Reads and enables pagination through a set of `Org`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [OrgsOrderBy!] | The method to use when ordering `Org`. | |
| condition | OrgCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | OrgFilter | A filter to be used in determining which values should be returned by the collection. | |
| orgsByStartChannelId | OrgsConnection! | Reads and enables pagination through a set of `Org`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [OrgsOrderBy!] | The method to use when ordering `Org`. | |
| condition | OrgCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | OrgFilter | A filter to be used in determining which values should be returned by the collection. | |
| channelsByDraftOf | ChannelsConnection! | Reads and enables pagination through a set of `Channel`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [ChannelsOrderBy!] | The method to use when ordering `Channel`. | |
| condition | ChannelCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | ChannelFilter | A filter to be used in determining which values should be returned by the collection. | |
| channelsByChildOf | ChannelsConnection! | Reads and enables pagination through a set of `Channel`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [ChannelsOrderBy!] | The method to use when ordering `Channel`. | |
| condition | ChannelCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | ChannelFilter | A filter to be used in determining which values should be returned by the collection. | |
| channelsByDuplicateOf | ChannelsConnection! | Reads and enables pagination through a set of `Channel`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [ChannelsOrderBy!] | The method to use when ordering `Channel`. | |
| condition | ChannelCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | ChannelFilter | A filter to be used in determining which values should be returned by the collection. | |
| screenContentHistoriesByChannelIdAndOrgId | ScreenContentHistoriesConnection! | Reads and enables pagination through a set of `ScreenContentHistory`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [ScreenContentHistoriesOrderBy!] | The method to use when ordering `ScreenContentHistory`. | |
| condition | ScreenContentHistoryCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | ScreenContentHistoryFilter | A filter to be used in determining which values should be returned by the collection. | |
| associationsByFromChannelAndOrgId | AssociationsConnection! | Reads and enables pagination through a set of `Association`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [AssociationsOrderBy!] | The method to use when ordering `Association`. | |
| condition | AssociationCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | AssociationFilter | A filter to be used in determining which values should be returned by the collection. | |
| associationsByToChannelAndOrgId | AssociationsConnection! | Reads and enables pagination through a set of `Association`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [AssociationsOrderBy!] | The method to use when ordering `Association`. | |
| condition | AssociationCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | AssociationFilter | A filter to be used in determining which values should be returned by the collection. | |
| embedsByChannelId | EmbedsConnection! | Reads and enables pagination through a set of `Embed`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [EmbedsOrderBy!] | The method to use when ordering `Embed`. | |
| condition | EmbedCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | EmbedFilter | A filter to be used in determining which values should be returned by the collection. | |
| shareAssociationsByShareChannel | ShareAssociationsConnection! | Reads and enables pagination through a set of `ShareAssociation`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [ShareAssociationsOrderBy!] | The method to use when ordering `ShareAssociation`. | |
| condition | ShareAssociationCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | ShareAssociationFilter | A filter to be used in determining which values should be returned by the collection. | |
| shareAssociationsByShareChannelAndOrgId | ShareAssociationsConnection! | Reads and enables pagination through a set of `ShareAssociation`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [ShareAssociationsOrderBy!] | The method to use when ordering `ShareAssociation`. | |
| condition | ShareAssociationCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | ShareAssociationFilter | A filter to be used in determining which values should be returned by the collection. | |
| tagAssociationsByToChannelAndOrgId | TagAssociationsConnection! | Reads and enables pagination through a set of `TagAssociation`. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| orderBy | [TagAssociationsOrderBy!] | The method to use when ordering `TagAssociation`. | |
| condition | TagAssociationCondition | A condition to be used in determining which values should be returned by the collection. | |
| filter | TagAssociationFilter | A filter to be used in determining which values should be returned by the collection. | |
| appInstancesByChannelId | AppInstancesConnection! | Get apps that contained in a channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| castedScreenByChannelId | ScreensConnection! | Get casted screen(s) by channel's id. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| channelsByChannelId | ChannelsConnection! | Get channel that contained in a channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| draft | Channel | Helper function for return draft version of a channel. | |
| filesByChannelId | FilesConnection! | Get files that contained in a channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| isParent | Boolean | Is this channel a parent channel | |
| layoutByChannel | Layout | ||
| linksByChannelId | LinksConnection! | Get links that contained in a channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| parentChannelByChildOf | ParentChannelByChildOf | Get parent channel by child of | |
| playingScreenNum | BigInt | Number of screens that currently playing the channel. | |
| playlistsByChannelId | PlaylistsConnection! | Get playlist that contained in a channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| published | Channel | Helper function for return published version of a channel. | |
| screensByChannelId | ScreensConnection! | Screens that currently playing the channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| sharedSpacesByChannelId | SpacesConnection! | Spaces that currently got shared access to the channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| sharedSpacesWithSharingModeByChannelId | SharedSpaceWithSharingModesConnection! | Get shared spaces with sharing mode by channel id | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |
| filter | SharedSpaceWithSharingModeFilter | A filter to be used in determining which values should be returned by the collection. | |
| shortId | String | shortId for embeding | |
| sitesByChannelId | SitesConnection! | Get Sites that are contained in a channel. | |
| first | Int | Only read the first `n` values of the set. | |
| last | Int | Only read the last `n` values of the set. | |
| offset | Int | Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. | |
| before | Cursor | Read all values in the set before (above) this cursor. | |
| after | Cursor | Read all values in the set after (below) this cursor. | |