Skip to main content

Interface: CanvasesAccessSetArguments

Extends

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

Properties

access_level

access_level: "read" | "write";

Description

Desired level of access.

Defined in

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


canvas_id

canvas_id: string;

Description

Encoded ID of the canvas.

Inherited from

CanvasID.canvas_id

Defined in

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


channel_ids?

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

Description

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

Inherited from

Partial.channel_ids

Defined in

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


token?

optional token: string;

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token

Defined in

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


user_ids?

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

Description

List of encoded user IDs.

Inherited from

Partial.user_ids

Defined in

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