Skip to main content

Interface: CanvasesAccessSetArguments

Defined in: packages/web-api/src/types/request/canvas.ts:61

Extends​

  • CanvasID.Partial<ChannelIDs>.TokenOverridable.Partial<UserIDs>

Properties​

access_level​

access_level: "read" | "write";

Defined in: packages/web-api/src/types/request/canvas.ts:63

Description​

Desired level of access.

canvas_id​

canvas_id: string;

Defined in: packages/web-api/src/types/request/canvas.ts:6

Description​

Encoded ID of the canvas.

Inherited from​

CanvasID.canvas_id

channel_ids?​

optional channel_ids: [string, ...string[]];

Defined in: packages/web-api/src/types/request/common.ts:81

Description​

An array of channel IDs (must include at least one ID).

Inherited from​

Partial.channel_ids

token?​

optional token: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

user_ids?​

optional user_ids: [string, ...string[]];

Defined in: packages/web-api/src/types/request/common.ts:92

Description​

List of encoded user IDs.

Inherited from​

Partial.user_ids