jamespot-user-api
    Preparing search index...

    Class JCalendarApi

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    network: Network

    Methods

    • Parameters

      • params: {
            end?: string;
            idArticle?: number;
            idSpot?: number;
            mode?: "user" | "spot";
            start?: string;
        }

      Returns Promise<
          ApiWrapper<
              {
                  backgroundColor?: string;
                  bgColor?: string;
                  color?: string;
                  end: string;
                  idArticle: number;
                  start: string;
                  subscribe: boolean;
                  textColor?: string;
                  title: string;
                  url: string;
              }[],
              BaseMessages,
          >,
      >

      Use getEventsV2 instead.

    • Type Parameters

      Parameters

      • params: {
            dateEnd: string;
            dateStart: string;
            spotId?: number;
            statuses?: ("subscribed" | "unanswered" | "refused")[];
            types?: string[];
        }
      • Optionaloptions: { format?: "raw-little" | "raw-list" | "raw-view"; signal?: AbortSignal }

      Returns Promise<
          ApiWrapper<
              CalendarEventWithExtensions<
                  T,
                  ["socialEventRecord", "recurringEventRecord"],
              >[],
              BaseMessages,
          >,
      >

    • Parameters

      • params: {
            idArticle: number;
            list:
                | "unit"
                | "onSpot"
                | "visio"
                | "available"
                | "unavailable"
                | "presence"
                | "refused"
                | "all"
                | "waiting";
            text: string;
            userURI?: string;
        }

      Returns Promise<ApiWrapper<boolean, BaseMessages>>

    • Type Parameters

      • P extends {
            address?: string | null;
            allDay?: boolean;
            bgColor?: string | null;
            dateEnd: string;
            dateStart: string;
            description?: string;
            hideFromCalendar?: boolean;
            noGestion?: boolean;
            place?: string | null;
            publishTo?: string;
            socialEventCeiling?: number | null;
            socialEventUseCeiling?: boolean;
            textColor?: string | null;
            title: string;
            token: string;
            type: "socialEvent";
            uiObjectLink?: string;
            urlGestion?: string;
            useQrcode?: boolean;
        } & { alertAuthor?: "0"
        | "1"; idDraft?: number; sendAlert?: "0" | "1" } = {
            address?: string | null;
            allDay?: boolean;
            bgColor?: string | null;
            dateEnd: string;
            dateStart: string;
            description?: string;
            hideFromCalendar?: boolean;
            noGestion?: boolean;
            place?: string | null;
            publishTo?: string;
            socialEventCeiling?: number | null;
            socialEventUseCeiling?: boolean;
            textColor?: string | null;
            title: string;
            token: string;
            type: "socialEvent";
            uiObjectLink?: string;
            urlGestion?: string;
            useQrcode?: boolean;
        } & { alertAuthor?: "0"
        | "1"; idDraft?: number; sendAlert?: "0" | "1" }
      • F extends "raw-little" | "raw-list" | "raw-view" = VIEW
      • E extends ArticleFormatsExtension = []

      Parameters

      • payload: P & { hiddenOccurrenceDateTime: string }
      • Optionaloptions: { format?: F; formatExtension?: E; signal?: AbortSignal }

      Returns PromiseApiWrapper<ArticleReturn<F, "socialEvent", E>>