Bluestep JS Documentation
    Preparing search index...

    Class AlertBuilder

    TODO

    Put example here
    
    Index

    Constructors

    Methods

    • Specifies the Instant that this alert is to be no longer available. Throws an error if null is passed.

      Parameters

      Returns AlertBuilder

    • Sets the specific users (by their ids) for which this alert is to affect.

      Parameters

      Returns AlertBuilder

    • TODO

      Parameters

      • url: string

      Returns AlertBuilder

    • Sets the message for this alert. Throws an error if null is passed.

      Parameters

      • message: string

      Returns AlertBuilder

    • Sets the priority level for this alert.

      Parameters

      • priority: number

      Returns AlertBuilder

    • Triggers the sending of this alert. If the required properties type, message, endDate are missing, an error will be thrown.

      Returns Alert

    • TODO

      Parameters

      • snooze: number

      Returns AlertBuilder

    • Sets the name of the sound for this alert. Must be among a select list

      Parameters

      • name: "bark" | "bong" | "chime" | "error" | "info" | "knock" | "phaser" | "vibrate"

      Returns AlertBuilder

    • Sets/overrides the existing alert type. This is a read-only String value containing the type of the alert. It is one of three values: "percent", "signature" or "auto". The percent type allows the recipient to set the status of the alert to a percent value between 0 and 100 in increments of 10 percent. The signature type allows the status to be set to 100 by checking a box. The auto type does not allow the recipient to set the status.

      Parameters

      • type: "percent" | "signature" | "auto"

      Returns void

    • TODO

      Parameters

      • id: string

      Returns AlertBuilder

    • Sets the specific users (by their string usernames) for which this alert is to affect.

      Parameters

      • usernames: string[]

      Returns AlertBuilder

    • Sets the specific users (by their user object) for which this alert is to affect.

      Parameters

      Returns AlertBuilder