Creating Plot Twists
    Preparing search index...

    Type Alias Actor

    Represents an actor in Plot - a user, contact, or twist.

    Actors can be associated with activities as authors, assignees, or mentions. The email field is only included when ContactAccess.Read permission is granted.

    const actor: Actor = {
      id: "f0ffd5f8-1635-4b13-9532-35f97446db90" as ActorId,
      type: ActorType.Contact,
      email: "[email protected]",  // Only if ContactAccess.Read
      name: "John Doe"
    };
    type Actor = {
        id: ActorId;
        type: ActorType;
        email?: string | null;
        name?: string | null;
    }
    Index

    Properties

    id type email? name?

    Properties

    id: ActorId

    Unique identifier for the actor

    type: ActorType

    Type of actor (User, Contact, or Twist)

    email?: string | null

    Email address (only included with ContactAccess.Read permission).

    • undefined: No permission to read email
    • null: Permission granted but email not set
    • string: Email address
    name?: string | null

    Display name.

    • undefined: Not included due to permissions
    • null: Not set
    • string: Display name

    Settings

    Member Visibility

    On This Page

    Properties