zendesk-messaging-client
    Preparing search index...

    Type Alias LocationMessageReadable

    A location type message includes the coordinates (latitude and longitude) of a location and an optional location object which can include the name and address of the location. Typically sent in response to a Location Request.

    type LocationMessageReadable = {
        blockChatInput?: boolean;
        coordinates: { lat: number; long: number };
        location?: { address?: string; name?: string };
        text?: string;
        type: string;
    }
    Index

    Properties

    blockChatInput? coordinates location? text? type

    Properties

    blockChatInput?: boolean

    When set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user's ability to send messages in the conversation.

    coordinates: { lat: number; long: number }

    The coordinates of the location.

    Type declaration

    • lat: number

      Global latitude.

    • long: number

      Global longitude.

    location?: { address?: string; name?: string }

    Information about the location.

    Type declaration

    • Optionaladdress?: string

      A string representing the address of the location.

    • Optionalname?: string

      A string representing the name of the location.

    Optional Readonlytext

    text?: string

    The fallback text message used when location messages are not supported by the channel.

    type: string

    The type of message.

    Settings

    Member Visibility

    On This Page

    Properties