signLiveToken
signLiveToken(
claims,secret,expiresInSeconds?):string
Defined in: tokens.ts:17
Parameters
Section titled “Parameters”claims
Section titled “claims”access
Section titled “access”"read" | "write" | "suggest" = liveAccessSchema
{ color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; } = liveActorSchema
actor.color?
Section titled “actor.color?”string = ...
actor.id
Section titled “actor.id”string = ...
actor.kind
Section titled “actor.kind”"human" | "agent" = ...
actor.name
Section titled “actor.name”string = ...
actor.onBehalfOf?
Section titled “actor.onBehalfOf?”{ id: string; name: string; } = ...
actor.onBehalfOf.id
Section titled “actor.onBehalfOf.id”string = ...
actor.onBehalfOf.name
Section titled “actor.onBehalfOf.name”string = ...
docName
Section titled “docName”string = ...
"extension" | "script" = ...
workspaceId
Section titled “workspaceId”string = ...
secret
Section titled “secret”string
expiresInSeconds?
Section titled “expiresInSeconds?”number = 300
Returns
Section titled “Returns”string