nodes/generated

Interface ZulipNodeParameters

Source
interface ZulipNodeParameters {
    additionalFields?:
        | {
            announce?: boolean;
            authorizationErrorsFatal?: boolean;
            historyPublicToSubscribers?: boolean;
            inviteOnly?: boolean;
            principals?: { properties: { email: string }[] };
            streamPostPolicy?: 1 | 3 | 2;
        }
        | {
            includeAllActive?: boolean;
            includeDefault?: boolean;
            includeOwnersubscribed?: boolean;
            includePublic?: boolean;
            includeSubscribed?: boolean;
        }
        | { includeSubscribers?: boolean }
        | {
            description?: string;
            historyPublicToSubscribers?: boolean;
            isAnnouncementOnly?: boolean;
            isPrivate?: boolean;
            newName?: string;
            streamPostPolicy?: 1 | 3 | 2;
        }
        | {
            clientGravatar?: boolean;
            includeCustomProfileFields?: boolean;
        }
        | {
            fullName?: string;
            isAdmin?: boolean;
            isGuest?: boolean;
            profileData?: {
                property: { id: string; value?: string }[];
            };
            role?: 200
            | 400
            | 600
            | 300
            | 100;
        };
    additionalFieldsJson?: string;
    content?: string;
    dataBinaryProperty?: string;
    email?: string;
    fullName?: string;
    jsonParameters?: boolean;
    messageId?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "deactivate"
    | "sendPrivate"
    | "sendStream"
    | "updateFile"
    | "getSubscribed";
    password?: string;
    resource?: "message"
    | "user"
    | "stream";
    shortName?: string;
    stream?: string;
    streamId?: string;
    subscriptions?: {
        properties: { description: string; name: string }[];
    };
    to?: unknown[];
    topic?: string;
    updateFields?: {
        content?: string;
        propagateMode?: | "changeOne"
        | "changeLater"
        | "changeAll";
        topic?: string;
    };
    userId?: string;
}

Properties§

§readonly additionalFields?:
    | {
        announce?: boolean;
        authorizationErrorsFatal?: boolean;
        historyPublicToSubscribers?: boolean;
        inviteOnly?: boolean;
        principals?: { properties: { email: string }[] };
        streamPostPolicy?: 1 | 3 | 2;
    }
    | {
        includeAllActive?: boolean;
        includeDefault?: boolean;
        includeOwnersubscribed?: boolean;
        includePublic?: boolean;
        includeSubscribed?: boolean;
    }
    | { includeSubscribers?: boolean }
    | {
        description?: string;
        historyPublicToSubscribers?: boolean;
        isAnnouncementOnly?: boolean;
        isPrivate?: boolean;
        newName?: string;
        streamPostPolicy?: 1 | 3 | 2;
    }
    | {
        clientGravatar?: boolean;
        includeCustomProfileFields?: boolean;
    }
    | {
        fullName?: string;
        isAdmin?: boolean;
        isGuest?: boolean;
        profileData?: {
            property: { id: string; value?: string }[];
        };
        role?: 200
        | 400
        | 600
        | 300
        | 100;
    }

Default: {}

§readonly additionalFieldsJson?: string

JSON format parameters for stream creation Type options: {"alwaysOpenEditWindow":true}

§readonly content?: string

The content of the message

§readonly dataBinaryProperty?: string

Default: "data"

§readonly email?: string

The email address of the new user

§readonly fullName?: string

The full name of the new user

§readonly jsonParameters?: boolean
§readonly messageId?: string

Unique identifier for the message

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "deactivate"
    | "sendPrivate"
    | "sendStream"
    | "updateFile"
    | "getSubscribed"

Default: "sendPrivate"

§readonly password?: string

The password of the new user Type options: {"password":true}

§readonly resource?: "message" | "user" | "stream"

Default: "message"

§readonly shortName?: string

The short name of the new user. Not user-visible.

§readonly stream?: string

The destination stream, or a comma-separated list containing the usernames (emails) of the recipients. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getStreams"}

§readonly streamId?: string

ID of stream to update

§readonly subscriptions?: { ... }

A list of dictionaries containing the the key name and value specifying the name of the stream to subscribe. If the stream does not exist a new stream is created. Default: {} Type options: {"multipleValues":true}

§readonly to?: unknown[]

The destination stream, or a comma-separated list containing the usernames (emails) of the recipients. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getUsers"}

§readonly topic?: string

The topic of the message. Only required if type is stream, ignored otherwise. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsDependsOn":["stream"],"loadOptionsMethod":"getTopics"}

§readonly updateFields?: { ... }

Default: {}

§readonly userId?: string

The ID of user to get