Frodo Library - v4.0.0-24
    Preparing search index...

    Type Alias IgaEvent

    type IgaEvent = {
        createEvent(eventData: EventSkeleton): Promise<EventSkeleton>;
        deleteEvent(eventId: string): Promise<EventSkeleton>;
        deleteEventByName(eventName: string): Promise<EventSkeleton>;
        deleteEvents(
            resultCallback?: ResultCallback<EventSkeleton>,
        ): Promise<EventSkeleton[]>;
        exportEvent(
            eventId: string,
            options?: EventExportOptions,
        ): Promise<EventExportInterface>;
        exportEventByName(
            eventName: string,
            options?: EventExportOptions,
        ): Promise<EventExportInterface>;
        exportEvents(
            options?: EventExportOptions,
            resultCallback?: ResultCallback<EventExportInterface>,
        ): Promise<EventExportInterface>;
        importEvents(
            importData: EventExportInterface,
            eventId?: string,
            eventName?: string,
            options?: EventImportOptions,
            resultCallback?: ResultCallback<EventSkeleton>,
        ): Promise<EventSkeleton[]>;
        readEvent(eventId: string): Promise<EventSkeleton>;
        readEventByName(eventName: string): Promise<EventSkeleton>;
        readEvents(): Promise<EventSkeleton[]>;
        updateEvent(
            eventId: string,
            eventData: EventSkeleton,
        ): Promise<EventSkeleton>;
    }
    Index

    Methods

    createEvent deleteEvent deleteEventByName deleteEvents exportEvent exportEventByName exportEvents importEvents readEvent readEventByName readEvents updateEvent

    Methods

    • Delete event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.

      Parameters

      • eventName: string

        The event name

      Returns Promise<EventSkeleton>

      A promise that resolves to a event object

    • Read event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.

      Parameters

      • eventName: string

        the event name

      Returns Promise<EventSkeleton>

      a promise that resolves to a event object

    Settings

    Member Visibility

    On This Page

    Methods