Boards
Last updated
Queries
portalBoards query
Retrieve portalBoards data from the Viio GraphQL API.
portalBoards(first: Int, after: String, last: Int, before: String, where: PortalBoardFilterInput, order: [PortalBoardSortInput!]): PortalBoardsConnection
Returns: PortalBoardsConnection
Arguments for portalBoards
| Name | Description |
|---|---|
where (PortalBoardFilterInput) | |
order ([PortalBoardSortInput!]) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
portalBoard query
Retrieve portalBoard data from the Viio GraphQL API.
portalBoard(input: PortalBoardInput!): PortalBoard
Returns: PortalBoard
Arguments for portalBoard
| Name | Description |
|---|---|
input (PortalBoardInput!) |
Mutations
createPortalBoard mutation
Run the createPortalBoard mutation through the Viio GraphQL API.
createPortalBoard(input: CreatePortalBoardInput!): CreatePortalBoardPayload!
Returns: CreatePortalBoardPayload!
Arguments for createPortalBoard
| Name | Description |
|---|---|
input (CreatePortalBoardInput!) |
renamePortalBoard mutation
Run the renamePortalBoard mutation through the Viio GraphQL API.
renamePortalBoard(input: RenamePortalBoardInput!): RenamePortalBoardPayload!
Returns: RenamePortalBoardPayload!
Arguments for renamePortalBoard
| Name | Description |
|---|---|
input (RenamePortalBoardInput!) |
updatePortalBoardContent mutation
Run the updatePortalBoardContent mutation through the Viio GraphQL API.
updatePortalBoardContent(input: UpdatePortalBoardContentInput!): UpdatePortalBoardContentPayload!
Returns: UpdatePortalBoardContentPayload!
Arguments for updatePortalBoardContent
| Name | Description |
|---|---|
input (UpdatePortalBoardContentInput!) |
removePortalBoards mutation
Run the removePortalBoards mutation through the Viio GraphQL API.
removePortalBoards(where: PortalBoardFilterInput): RemovePortalBoardsPayload!
Returns: RemovePortalBoardsPayload!
Arguments for removePortalBoards
| Name | Description |
|---|---|
where (PortalBoardFilterInput) |
setPortalBoardPrivacy mutation
Run the setPortalBoardPrivacy mutation through the Viio GraphQL API.
setPortalBoardPrivacy(input: SetPortalBoardPrivacyInput!, where: PortalBoardFilterInput): SetPortalBoardPrivacyPayload!
Returns: SetPortalBoardPrivacyPayload!
Arguments for setPortalBoardPrivacy
| Name | Description |
|---|---|
input (SetPortalBoardPrivacyInput!) | |
where (PortalBoardFilterInput) |
Objects
CreatePortalBoardPayload object
Fields returned by the CreatePortalBoardPayload object type.
| Name | Description |
|---|---|
portalBoard (PortalBoard!) |
PortalBoard object
Fields returned by the PortalBoard object type.
| Name | Description |
|---|---|
id (ID!) | |
type (PortalBoardType!) | |
name (String!) | |
ownerId (ID!) | |
isPrivate (Boolean!) | |
createdAt (DateTime!) | |
updatedAt (DateTime!) | |
content (JSON) | |
owner (User) |
PortalBoardNotFoundError object
Fields returned by the PortalBoardNotFoundError object type.
| Name | Description |
|---|---|
message (String!) |
PortalBoardsConnection object
A connection to a list of items.
| Name | Description |
|---|---|
pageInfo (PageInfo!) | Information to aid in pagination. |
edges ([PortalBoardsEdge!]) | A list of edges. |
nodes ([PortalBoard!]) | A flattened list of the nodes. |
totalCount (Int!) | Identifies the total count of items in the connection. |
PortalBoardsEdge object
An edge in a connection.
| Name | Description |
|---|---|
cursor (String!) | A cursor for use in pagination. |
node (PortalBoard!) | The item at the end of the edge. |
RemovePortalBoardsPayload object
Fields returned by the RemovePortalBoardsPayload object type.
| Name | Description |
|---|---|
removedCount (Int!) |
RenamePortalBoardPayload object
Fields returned by the RenamePortalBoardPayload object type.
| Name | Description |
|---|---|
portalBoard (PortalBoard) | |
errors ([RenamePortalBoardError!]) |
SetPortalBoardPrivacyPayload object
Fields returned by the SetPortalBoardPrivacyPayload object type.
| Name | Description |
|---|---|
modifiedCount (Int!) |
UpdatePortalBoardContentPayload object
Fields returned by the UpdatePortalBoardContentPayload object type.
| Name | Description |
|---|---|
portalBoard (PortalBoard) | |
errors ([UpdatePortalBoardContentError!]) |
Input Types
CreatePortalBoardInput input
Input fields accepted by CreatePortalBoardInput.
| Name | Description |
|---|---|
name (String!) | |
type (PortalBoardType!) | |
isPrivate (Boolean) | |
content (JSON) |
PortalBoardFilterInput input
Input fields accepted by PortalBoardFilterInput.
| Name | Description |
|---|---|
and ([PortalBoardFilterInput!]) | |
or ([PortalBoardFilterInput!]) | |
id (ComparableIdTypeOperationFilterInput) | |
type (PortalBoardTypeOperationFilterInput) | |
name (StringOperationFilterInput) | |
ownerId (ComparableIdTypeOperationFilterInput) | |
isPrivate (BooleanOperationFilterInput) |
PortalBoardInput input
Input fields accepted by PortalBoardInput.
| Name | Description |
|---|---|
id (ID!) |
PortalBoardSortInput input
Input fields accepted by PortalBoardSortInput.
| Name | Description |
|---|---|
id (SortEnumType) | |
createdAt (SortEnumType) | |
updatedAt (SortEnumType) | |
name (SortEnumType) |
PortalBoardTypeOperationFilterInput input
Input fields accepted by PortalBoardTypeOperationFilterInput.
| Name | Description |
|---|---|
eq (PortalBoardType) | |
neq (PortalBoardType) | |
in ([PortalBoardType!]) | |
nin ([PortalBoardType!]) |
RenamePortalBoardInput input
Input fields accepted by RenamePortalBoardInput.
| Name | Description |
|---|---|
id (ID!) | |
name (String!) |
SetPortalBoardPrivacyInput input
Input fields accepted by SetPortalBoardPrivacyInput.
| Name | Description |
|---|---|
isPrivate (Boolean!) |
UpdatePortalBoardContentInput input
Input fields accepted by UpdatePortalBoardContentInput.
| Name | Description |
|---|---|
id (ID!) | |
content (JSON) |
Unions
RenamePortalBoardError union
Possible object types returned by the RenamePortalBoardError union.
Possible types: PortalBoardNotFoundError
UpdatePortalBoardContentError union
Possible object types returned by the UpdatePortalBoardContentError union.
Possible types: PortalBoardNotFoundError
Enums
PortalBoardType enum
Accepted values for the PortalBoardType enum.
| Value | Description |
|---|---|
ANALYTICS |
Scalars
JSON scalar
The custom JSON scalar used by the Viio GraphQL API.