Azure Connectors Node.js SDK
    Preparing search index...

    Interface GetBoardOptions

    Options for the getBoard operation.

    interface GetBoardOptions {
        abortSignal?: AbortSignalLike;
        actionEntities?: boolean;
        actionFields?: string;
        actionMember?: boolean;
        actionMemberCreator?: boolean;
        actionMemberCreatorFields?: string;
        actionMemberFields?: string;
        actions?: string;
        actionsDisplay?: boolean;
        actionsFormat?: string;
        actionsLimit?: number;
        actionsSince?: string;
        boardStars?: string;
        cardAttachmentFields?: string;
        cardAttachments?: boolean;
        cardChecklists?: string;
        cardFields?: string;
        cards?: string;
        cardStickers?: boolean;
        checklistFields?: string;
        checklists?: string;
        fields?: string;
        labelFields?: string;
        labels?: string;
        labelsLimit?: number;
        listFields?: string;
        lists?: string;
        memberFields?: string;
        members?: string;
        memberships?: string;
        membershipsMember?: boolean;
        membershipsMemberFields?: string;
        membersInvited?: string;
        membersInvitedFields?: string;
        myPerfs?: boolean;
        onResponse?: ConnectorRawResponseCallback;
        organization?: boolean;
        organizationFields?: string;
        organizationMemberships?: string;
        tracingOptions?: OperationTracingOptions;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    actionEntities?: boolean

    A boolean value (true, false) determining whether or not to return action entities.

    actionFields?: string

    List the fields to return with each field. Specify 'all' or a comma seperated list of valid values.

    actionMember?: boolean

    A boolean value (true, false) determining whether or not to return action members.

    actionMemberCreator?: boolean

    A boolean value (true, false) determining whether or not to return action member creator.

    actionMemberCreatorFields?: string

    List the action member creator fields to return. Specify 'all' or a comma seperated list of valid values.

    actionMemberFields?: string

    List the member fields to return with each action member. Specify 'all' or a comma seperated list of valid values.

    actions?: string

    List the actions to return. Specify 'all' or a comma seperated list of valid values.

    actionsDisplay?: boolean

    A boolean value (true, false) determining whether or not to return actions display.

    actionsFormat?: string

    Specify the format of the actions to return. Valid options are 'count', 'list', 'minimal'.

    actionsLimit?: number

    Max number of actions to return.

    actionsSince?: string

    Only return the actions after this date.

    boardStars?: string

    Specify the board stars to return.

    cardAttachmentFields?: string

    List the attachment fields to return for each attachment. Specify 'all' or a comma seperated list of valid values.

    cardAttachments?: boolean

    A boolean value (true, false) determining whether or not to return attachments on cards.

    cardChecklists?: string

    Specify the checklists to return for each card.

    cardFields?: string

    List the fields to return for each card. Specify 'all' or a comma seperated list of valid values.

    cards?: string

    Specify the cards to return. Valid options are 'all', 'closed', 'none', 'open', or 'visible'.

    cardStickers?: boolean

    A boolean value (true, false) determining whether or not to return card stickers.

    checklistFields?: string

    List the checklist fields to return for each checklist. Specify 'all' or a comma seperated list of valid values.

    checklists?: string

    Specify the checklists to return.

    fields?: string

    List the fields to return. Specify 'all' or a comma seperated list of valid values.

    labelFields?: string

    List the label fields to return for each label. Specify 'all' or a comma seperated list of valid values.

    labels?: string

    Specify the labels to return.

    labelsLimit?: number

    Max number of labels to return.

    listFields?: string

    List the list fields to return for each list. Specify 'all' or a comma seperated list of valid values.

    lists?: string

    Specify the lists to return.

    memberFields?: string

    List the member fields to return for each member. Specify 'all' or a comma seperated list of valid values.

    members?: string

    List the members to return. Specify 'all' or a comma seperated list of valid values.

    memberships?: string

    List the memberships to return. Specify 'all' or a comma seperated list of valid values.

    membershipsMember?: boolean

    A boolean value (true, false) determining whether or not to return membership members.

    membershipsMemberFields?: string

    List the member fields to return for each membership member. Specify 'all' or a comma seperated list of valid values.

    membersInvited?: string

    Specify the invited members to return.

    membersInvitedFields?: string

    List the fields to return for each. Specify 'all' or a comma seperated list of valid values.

    myPerfs?: boolean

    A boolean value (true, false) determining whether or not to return my perfs.

    Callback invoked with the complete response before the operation returns or throws.

    organization?: boolean

    A boolean value (true, false) determining whether or not to return the organization information.

    organizationFields?: string

    List the organization fields to return for each organization. Specify 'all' or a comma seperated list of valid values.

    organizationMemberships?: string

    List the organization memberships to return. Specify 'all' or a comma seperated list of valid values.

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.