Class StoryElement

Constructor for interactive story elements.

Example

     const element = StoryElement
         .at({ x: 0, y: 0, width: 10, height: 10 })
         .reaction('👍', { dark: true })

Index

Methods

location reaction url venue venueFromInline at

Methods

location

location(params): RawMediaAreaGeoPoint
Parameters
- params: {
  latitude: number;
  longitude: number;
  }
  - latitude: number
    Latitude of the geolocation
  - longitude: number
    Longitude of the geolocation
Returns RawMediaAreaGeoPoint
- Defined in packages/core/src/highlevel/types/stories/interactive/input.ts:84

reaction

reaction(reaction, params?): RawMediaAreaSuggestedReaction
Parameters
- reaction: InputReaction
- params: {
  dark?: boolean;
  flipped?: boolean;
  } = {}
  - Optionaldark?: boolean
    Whether this reaction is on a dark background
  - Optionalflipped?: boolean
    Whether this reaction is flipped (i.e. has tail on the left)
Returns RawMediaAreaSuggestedReaction
- Defined in packages/core/src/highlevel/types/stories/interactive/input.ts:107

url

url(url): RawMediaAreaUrl
Parameters
- url: string
Returns RawMediaAreaUrl
- Defined in packages/core/src/highlevel/types/stories/interactive/input.ts:134

venue

venue(params): RawMediaAreaVenue
Parameters
- params: {
      address: string;
      latitude: number;
      longitude: number;
      source: VenueSource;
      title: string;
  }
  - address: string
    Venue address
  - latitude: number
    Latitude of the geolocation
  - longitude: number
    Longitude of the geolocation
  - source: VenueSource
    Source where this venue was acquired
  - title: string
    Venue name
Returns RawMediaAreaVenue
- Defined in packages/core/src/highlevel/types/stories/interactive/input.ts:32

venueFromInline

venueFromInline(queryId, resultId): RawInputMediaAreaVenue
Parameters
- queryId: Long
- resultId: string
Returns RawInputMediaAreaVenue
- Defined in packages/core/src/highlevel/types/stories/interactive/input.ts:75

`Static`at

at(params): StoryElement
Parameters
- params: {
      height: number;
      rotation?: number;
      width: number;
      x: number;
      y: number;
  }
  - height: number
  - Optionalrotation?: number
  - width: number
  - x: number
  - y: number
Returns StoryElement
- Defined in packages/core/src/highlevel/types/stories/interactive/input.ts:21

Class StoryElement

Example

Index

Methods

Methods

location

Parameters

latitude: number

longitude: number

Returns RawMediaAreaGeoPoint

reaction

Parameters

`Optional`dark?: boolean

`Optional`flipped?: boolean

Returns RawMediaAreaSuggestedReaction

url

Parameters

Returns RawMediaAreaUrl

venue

Parameters

address: string

latitude: number

longitude: number

source: VenueSource

title: string

Returns RawMediaAreaVenue

venueFromInline

Parameters

Returns RawInputMediaAreaVenue

`Static`at

Parameters

height: number

`Optional`rotation?: number

width: number

x: number

y: number

Returns StoryElement

Settings

On This Page

Class StoryElement

Example

Index

Methods

Methods

location

Parameters

latitude: number

longitude: number

Returns RawMediaAreaGeoPoint

reaction

Parameters

Optionaldark?: boolean

Optionalflipped?: boolean

Returns RawMediaAreaSuggestedReaction

url

Parameters

Returns RawMediaAreaUrl

venue

Parameters

address: string

latitude: number

longitude: number

source: VenueSource

title: string

Returns RawMediaAreaVenue

venueFromInline

Parameters

Returns RawInputMediaAreaVenue

Staticat

Parameters

height: number

Optionalrotation?: number

width: number

x: number

y: number

Returns StoryElement

Settings

On This Page

`Optional`dark?: boolean

`Optional`flipped?: boolean

`Static`at

`Optional`rotation?: number