iland-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Event.

Hierarchy

  • Event

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

details

details:

Gets the string describing the event.

entityName

entityName:

Gets the entity name.

entityType

entityType:

Gets the entity type.

entityUuid

entityUuid:

Gets the entity UUID.

initiatedByFullName

initiatedByFullName:

Gets the full name of the user who caused the event.

initiatedByUsername

initiatedByUsername:

Gets the username of the user who caused the event.

json

json:

Gets the raw JSON object from the API.

ownerId

ownerId:

Gets the event owner ID.

ownerType

ownerType:

Gets the event owner type.

taskUuid

taskUuid:

Gets the UUID of the task that is associated with the event or null if not applicable.

timestamp

timestamp:

Gets the event timestamp.

type

type:

Gets the event type.

uuid

uuid:

Gets the event UUID.

Methods

toString

  • toString(): string

Static getEvent

  • getEvent(uuid: string): Promise<Event>

  • Gets an event by UUID.

    Parameters

    • uuid: string

      event UUID

    Returns Promise<Event>

    promise that resolves with the Event

Static getEvents

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc