jamespot-user-api
    Preparing search index...

    Class JUserApi

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    network: Network

    Methods

    • Returns Promise<
          ApiWrapper<
              {
                  user_field_edit_profil: Partial<
                      Record<
                          | "function"
                          | "title"
                          | "image"
                          | "firstname"
                          | "lastname"
                          | "mail"
                          | "description"
                          | "dateOfBirth"
                          | "phoneNumber"
                          | "language"
                          | "timeZone"
                          | "mobileNumber"
                          | "company"
                          | "country"
                          | "department"
                          | "webSite"
                          | "userBanner"
                          | "field1"
                          | "field2"
                          | "field3"
                          | "field4"
                          | "field5",
                          number,
                      >,
                  >;
                  user_field_editable: Partial<
                      Record<
                          | "function"
                          | "title"
                          | "image"
                          | "firstname"
                          | "lastname"
                          | "mail"
                          | "description"
                          | "dateOfBirth"
                          | "phoneNumber"
                          | "language"
                          | "timeZone"
                          | "mobileNumber"
                          | "company"
                          | "country"
                          | "department"
                          | "webSite"
                          | "userBanner"
                          | "field1"
                          | "field2"
                          | "field3"
                          | "field4"
                          | "field5",
                          number,
                      >,
                  >;
                  user_field_my_page: Partial<
                      Record<
                          | "function"
                          | "title"
                          | "image"
                          | "firstname"
                          | "lastname"
                          | "mail"
                          | "description"
                          | "dateOfBirth"
                          | "phoneNumber"
                          | "language"
                          | "timeZone"
                          | "mobileNumber"
                          | "company"
                          | "country"
                          | "department"
                          | "webSite"
                          | "userBanner"
                          | "field1"
                          | "field2"
                          | "field3"
                          | "field4"
                          | "field5",
                          number,
                      >,
                  >;
                  user_page_mandatory_fields: {
                      firstname: "0"
                      | "1";
                      lastname: "0" | "1";
                      pseudo: "0" | "1";
                  };
              },
              BaseMessages,
          >,
      >

    • Type Parameters

      Parameters

      • payload: ObjectListProps
      • Optionalparams: {
            formatExtension?: (
                | "comments"
                | "search"
                | "actions"
                | "attachments"
                | "contact"
                | "filebank"
                | "licenses"
                | "licensesExtrabot"
                | "messenger"
                | "filebankPath"
                | "parentArticle"
                | "quarantine"
                | "quizFieldDefinitions"
                | "quizResponseRecord"
                | "recurringEventRecord"
                | "socialEventRecord"
                | "surveyDateRecord"
                | "bookmark"
            )[];
            signal?: AbortSignal;
        }

      Returns Promise<ApiPagingResults<T>>

    • Type Parameters

      Parameters

      • payload: ObjectListProps
      • Optionalparams: {
            formatExtension?: (
                | "comments"
                | "search"
                | "actions"
                | "attachments"
                | "contact"
                | "filebank"
                | "licenses"
                | "licensesExtrabot"
                | "messenger"
                | "filebankPath"
                | "parentArticle"
                | "quarantine"
                | "quizFieldDefinitions"
                | "quizResponseRecord"
                | "recurringEventRecord"
                | "socialEventRecord"
                | "surveyDateRecord"
                | "bookmark"
            )[];
            signal?: AbortSignal;
        }

      Returns Promise<ApiPagingResults<T>>

    • Type Parameters

      • F extends "raw-little" | "raw-list" | "raw-view" = LIST
      • T extends string | number | symbol = never
      • E extends ArticleFormatsExtension = []

      Parameters

      • user: {
            company?: string;
            field1?: string;
            field2?: string;
            field3?: string;
            field4?: string;
            field5?: string;
            firstname: string;
            function?: string;
            lastname: string;
            mail?: string;
            phoneNumber?: string;
            title: string;
            uri: string;
        }
      • Optionaloptions: { format?: F; formatExtension?: E; signal?: AbortSignal }

      Returns Promise<ApiWrapper<ArticleReturn<F, T, E>, BaseMessages>>

    • Parameters

      • values: {
            businessManagementManager?: UserLittle[];
            businessNetworkingUserToCompanySrc?: UserLittle[];
            company: string;
            country: string;
            dateOfBirth: string;
            department: string;
            description: string;
            field1: string;
            field2: string;
            field3: string;
            field4: string;
            field5: string;
            firstname: string;
            function: string;
            image?: string;
            language:
                | "es"
                | "de"
                | "en"
                | "fl"
                | "fr"
                | "it"
                | "nl"
                | "pl"
                | "pt"
                | "ro"
                | "tr";
            lastname: string;
            level: string;
            mail?: string;
            mobileNumber: string;
            phoneNumber: string;
            timeZone: string;
            title: string;
            userBanner?: string;
            webSite: string;
        }

      Returns Promise<ApiWrapper<jUserLittle, BaseMessages>>