nodes/generated

Interface OrbitNodeParameters

Source


interface OrbitNodeParameters {
    additionalFields?:
        | {
            activityType?: string;
            description?: string;
            key?: string;
            link?: string;
            linkText?: string;
            occurredAt?: string;
        }
        | {
            bio?: string;
            birthday?: string;
            company?: string;
            location?: string;
            name?: string;
            pronouns?: string;
            shippingAddress?: string;
            slug?: string;
            tagList?: string;
            tagsToAdd?: string;
            teammate?: boolean;
            tShirt?: string;
            url?: string;
        }
        | { publishedAt?: string };
    email?: string;
    filters?: { memberId?: string };
    host?: string;
    id?: string;
    identityUi?: {
        identityValue: {
            email: string;
            host: string;
            id: string;
            searchBy: "id" | "username";
            source?: "github" | "twitter" | "email" | "discourse";
            username: string;
        };
    };
    limit?: number;
    memberId?: string;
    note?: string;
    noteId?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upsert"
    | "lookup";
    options?: { direction?: "ASC"
    | "DESC"; sort?: string };
    postId?: string;
    resolveIdentities?: boolean;
    resolveMember?: boolean;
    resource?: "member" | "post" | "note" | "activity";
    returnAll?: boolean;
    searchBy?: "id" | "username";
    source?: "github" | "twitter" | "email" | "discourse";
    title?: string;
    updateFields?: {
        bio?: string;
        birthday?: string;
        company?: string;
        location?: string;
        name?: string;
        pronouns?: string;
        shippingAddress?: string;
        slug?: string;
        tagList?: string;
        tagsToAdd?: string;
        teammate?: boolean;
        tShirt?: string;
        url?: string;
    };
    url?: string;
    username?: string;
    workspaceId?: string;
}

Properties§

§readonly additionalFields?:
    | {
        activityType?: string;
        description?: string;
        key?: string;
        link?: string;
        linkText?: string;
        occurredAt?: string;
    }
    | {
        bio?: string;
        birthday?: string;
        company?: string;
        location?: string;
        name?: string;
        pronouns?: string;
        shippingAddress?: string;
        slug?: string;
        tagList?: string;
        tagsToAdd?: string;
        teammate?: boolean;
        tShirt?: string;
        url?: string;
    }
    | { publishedAt?: string }

Default: {}

§readonly email?: string

The email address

§readonly filters?: { ... }

Default: {}

§readonly host?: string
§readonly id?: string

The username at the source

§readonly identityUi?: { ... }

The identity is used to find the member. If no member exists, a new member will be created and linked to the provided identity. Default: {} Type options: {"multipleValues":false}

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly memberId?: string
§readonly note?: string
§readonly noteId?: string
§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upsert"
    | "lookup"

Default: "create"

§readonly options?: { ... }

Default: {}

§readonly postId?: string
§readonly resolveIdentities?: boolean

By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically.

§readonly resolveMember?: boolean
§readonly resource?: "member" | "post" | "note" | "activity"

Default: "member"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly searchBy?: "id" | "username"
§readonly source?: "github" | "twitter" | "email" | "discourse"

Set to github, twitter, email, discourse or the source of any identities you've manually created

§readonly title?: string
§readonly updateFields?: { ... }

Default: {}

§readonly url?: string

Supply any URL and Orbit will do its best job to parse out a title, description, and image

§readonly username?: string

The username at the source

§readonly workspaceId?: string

Choose from the list, or specify an ID using an expression Default: "Deprecated" Type options: {"loadOptionsMethod":"getWorkspaces"}