Type alias ShareInstrumentOptions

ShareInstrumentOptions: {
    context: any;
    priceCurrent: number;
    priceHigh?: number;
    priceLow?: number;
    priceOpen?: number;
    showMessage?: boolean;
    target: string[] | TeamChannelTarget;
    timestamp?: number;
}

Options provided to the share function to share financial instrument price information to a Teams chat.

Type declaration

  • context: any

    Instrument context data to share in the form of an FDC3 instrument context which must include the id.ticker value at a minimum and ideally name also (if required, you may also include additional properties and metadata to support your workflows).

  • priceCurrent: number

    The current price of the instrument.

  • Optional priceHigh?: number

    The session high price of the instrument.

  • Optional priceLow?: number

    The session low price of the instrument.

  • Optional priceOpen?: number

    The session open price of the instrument.

  • Optional showMessage?: boolean

    Determines whether the Teams app will open and focus on the message that was posted (defaults to true).

  • target: string[] | TeamChannelTarget

    Provide a list of user email addresses to share to a group chat of those users, otherwise provide team/channel IDs to share to a channel chat.

  • Optional timestamp?: number

    Timestamp corresponding to the price information. If not provided, the current time is used.

Settings

Member Visibility

Theme

Generated using TypeDoc