pl-api
    Preparing search index...

    Function eventsCategory

    • Parameters

      Returns {
          acceptEventParticipationRequest: (
              statusId: string,
              accountId: string,
          ) => Promise<Status>;
          createEvent: (params: CreateEventParams) => Promise<Status>;
          editEvent: (statusId: string, params: EditEventParams) => Promise<Status>;
          getEventIcs: (statusId: string) => Promise<string>;
          getEventParticipationRequests: (
              statusId: string,
              params?: PaginationParams,
          ) => Promise<
              PaginatedResponse<
                  {
                      account: {
                          __meta: { pleroma?: any; source?: any };
                          accepts_chat_messages: boolean | null;
                          acct: string;
                          ap_id: string | null;
                          avatar: string;
                          avatar_default: boolean;
                          avatar_description: string;
                          avatar_static: string;
                          background_image: string | null;
                          birthday?: string;
                          bot: boolean;
                          created_at: string;
                          custom_css: string;
                          deactivated?: boolean;
                          discoverable: boolean;
                          display_name: string;
                          domain: string;
                          emojis: {
                              category: string | null;
                              shortcode: string;
                              static_url: string;
                              url: string;
                              visible_in_picker: boolean;
                          }[];
                          enable_rss: boolean;
                          favicon?: string;
                          fields: { name: string; value: string; verified_at: string
                          | null }[];
                          followers_count: number;
                          following_count: number;
                          fqn: string;
                          group: boolean;
                          header: string;
                          header_default: boolean;
                          header_description: string;
                          header_static: string;
                          hide_collections?: boolean;
                          hide_favorites: boolean;
                          hide_followers?: boolean;
                          hide_followers_count?: boolean;
                          hide_follows?: boolean;
                          hide_follows_count?: boolean;
                          id: string;
                          identity_proofs: { name: string; value: string; verified_at: string }[];
                          indexable: boolean | null;
                          is_admin?: boolean;
                          is_cat: boolean;
                          is_moderator?: boolean;
                          is_suggested?: boolean;
                          last_status_at: string | null;
                          limited?: boolean;
                          local?: boolean;
                          location?: string;
                          locked: boolean;
                          memorial: boolean | null;
                          mention_policy: "none" | "only_known" | "only_contacts";
                          moved:
                              | {
                                  __meta: { pleroma?: any; source?: any };
                                  accepts_chat_messages: boolean | null;
                                  acct: string;
                                  ap_id: string | null;
                                  avatar: string;
                                  avatar_default: boolean;
                                  avatar_description: string;
                                  avatar_static: string;
                                  background_image: string | null;
                                  birthday?: string;
                                  bot: boolean;
                                  created_at: string;
                                  custom_css: string;
                                  deactivated?: boolean;
                                  discoverable: boolean;
                                  display_name: string;
                                  domain: string;
                                  emojis: {
                                      category: ...;
                                      shortcode: ...;
                                      static_url: ...;
                                      url: ...;
                                      visible_in_picker: ...;
                                  }[];
                                  enable_rss: boolean;
                                  favicon?: string;
                                  fields: { name: ...; value: ...; verified_at: ... }[];
                                  followers_count: number;
                                  following_count: number;
                                  fqn: string;
                                  group: boolean;
                                  header: string;
                                  header_default: boolean;
                                  header_description: string;
                                  header_static: string;
                                  hide_collections?: boolean;
                                  hide_favorites: boolean;
                                  hide_followers?: boolean;
                                  hide_followers_count?: boolean;
                                  hide_follows?: boolean;
                                  hide_follows_count?: boolean;
                                  id: string;
                                  identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                                  indexable: boolean | null;
                                  is_admin?: boolean;
                                  is_cat: boolean;
                                  is_moderator?: boolean;
                                  is_suggested?: boolean;
                                  last_status_at: string | null;
                                  limited?: boolean;
                                  local?: boolean;
                                  location?: string;
                                  locked: boolean;
                                  memorial: boolean | null;
                                  mention_policy: "none" | "only_known" | "only_contacts";
                                  noindex: boolean | null;
                                  note: string;
                                  payment_options: ((...) | (...))[];
                                  permit_followback?: boolean;
                                  pronouns: string[];
                                  relationship?: {
                                      blocked_by: ...;
                                      blocking: ...;
                                      domain_blocking: ...;
                                      endorsed: ...;
                                      followed_by: ...;
                                      following: ...;
                                      id: ...;
                                      languages: ...;
                                      muting: ...;
                                      muting_notifications: ...;
                                      note: ...;
                                      notifying: ...;
                                      requested: ...;
                                      showing_reblogs: ...;
                                  };
                                  roles: {
                                      color: ...;
                                      highlighted: ...;
                                      id: ...;
                                      name: ...;
                                      permissions: ...;
                                  }[];
                                  speak_as_cat: boolean;
                                  statuses_count: number;
                                  subscribers_count: number;
                                  suspended?: boolean;
                                  url: string;
                                  username: string;
                                  verified?: boolean;
                              }
                              | null;
                          noindex: boolean
                          | null;
                          note: string;
                          payment_options: (
                              | {
                                  href: (...)
                                  | (...);
                                  name: (...) | (...);
                                  object_id: (...) | (...);
                                  type: "link";
                              }
                              | {
                                  amount_min: (...)
                                  | (...);
                                  chain_id: (...) | (...);
                                  object_id: (...) | (...);
                                  price: (...) | (...);
                                  type: "monero-subscription";
                              }
                          )[];
                          permit_followback?: boolean;
                          pronouns: string[];
                          relationship?: {
                              blocked_by: boolean;
                              blocking: boolean;
                              domain_blocking: boolean;
                              endorsed: boolean;
                              followed_by: boolean;
                              following: boolean;
                              id: string;
                              languages: (...)[]
                              | null;
                              muting: boolean;
                              muting_notifications: boolean;
                              note: string;
                              notifying: boolean;
                              requested: boolean;
                              showing_reblogs: boolean;
                          };
                          roles: {
                              color: string;
                              highlighted: boolean;
                              id: string;
                              name: string;
                              permissions: string;
                          }[];
                          speak_as_cat: boolean;
                          statuses_count: number;
                          subscribers_count: number;
                          suspended?: boolean;
                          url: string;
                          username: string;
                          verified?: boolean;
                      } & WithMoved;
                      participation_message: string;
                  },
                  true,
              >,
          >;
          getEventParticipations: (
              statusId: string,
              params?: PaginationParams,
          ) => Promise<PaginatedResponse<Account, true>>;
          getJoinedEvents: (
              state?: "pending" | "reject" | "accept",
              params?: PaginationParams,
          ) => Promise<PaginatedResponse<Status, true>>;
          joinEvent: (
              statusId: string,
              participation_message?: string,
          ) => Promise<Status>;
          leaveEvent: (statusId: string) => Promise<Status>;
          rejectEventParticipationRequest: (
              statusId: string,
              accountId: string,
          ) => Promise<Status>;
      }

      • acceptEventParticipationRequest: (statusId: string, accountId: string) => Promise<Status>

        Accepts user to the event

      • createEvent: (params: CreateEventParams) => Promise<Status>

        Creates an event

      • editEvent: (statusId: string, params: EditEventParams) => Promise<Status>

        Edits an event

      • getEventIcs: (statusId: string) => Promise<string>

        Event ICS file

      • getEventParticipationRequests: (
            statusId: string,
            params?: PaginationParams,
        ) => Promise<
            PaginatedResponse<
                {
                    account: {
                        __meta: { pleroma?: any; source?: any };
                        accepts_chat_messages: boolean | null;
                        acct: string;
                        ap_id: string | null;
                        avatar: string;
                        avatar_default: boolean;
                        avatar_description: string;
                        avatar_static: string;
                        background_image: string | null;
                        birthday?: string;
                        bot: boolean;
                        created_at: string;
                        custom_css: string;
                        deactivated?: boolean;
                        discoverable: boolean;
                        display_name: string;
                        domain: string;
                        emojis: {
                            category: string | null;
                            shortcode: string;
                            static_url: string;
                            url: string;
                            visible_in_picker: boolean;
                        }[];
                        enable_rss: boolean;
                        favicon?: string;
                        fields: { name: string; value: string; verified_at: string
                        | null }[];
                        followers_count: number;
                        following_count: number;
                        fqn: string;
                        group: boolean;
                        header: string;
                        header_default: boolean;
                        header_description: string;
                        header_static: string;
                        hide_collections?: boolean;
                        hide_favorites: boolean;
                        hide_followers?: boolean;
                        hide_followers_count?: boolean;
                        hide_follows?: boolean;
                        hide_follows_count?: boolean;
                        id: string;
                        identity_proofs: { name: string; value: string; verified_at: string }[];
                        indexable: boolean | null;
                        is_admin?: boolean;
                        is_cat: boolean;
                        is_moderator?: boolean;
                        is_suggested?: boolean;
                        last_status_at: string | null;
                        limited?: boolean;
                        local?: boolean;
                        location?: string;
                        locked: boolean;
                        memorial: boolean | null;
                        mention_policy: "none" | "only_known" | "only_contacts";
                        moved:
                            | {
                                __meta: { pleroma?: any; source?: any };
                                accepts_chat_messages: boolean | null;
                                acct: string;
                                ap_id: string | null;
                                avatar: string;
                                avatar_default: boolean;
                                avatar_description: string;
                                avatar_static: string;
                                background_image: string | null;
                                birthday?: string;
                                bot: boolean;
                                created_at: string;
                                custom_css: string;
                                deactivated?: boolean;
                                discoverable: boolean;
                                display_name: string;
                                domain: string;
                                emojis: {
                                    category: ...;
                                    shortcode: ...;
                                    static_url: ...;
                                    url: ...;
                                    visible_in_picker: ...;
                                }[];
                                enable_rss: boolean;
                                favicon?: string;
                                fields: { name: ...; value: ...; verified_at: ... }[];
                                followers_count: number;
                                following_count: number;
                                fqn: string;
                                group: boolean;
                                header: string;
                                header_default: boolean;
                                header_description: string;
                                header_static: string;
                                hide_collections?: boolean;
                                hide_favorites: boolean;
                                hide_followers?: boolean;
                                hide_followers_count?: boolean;
                                hide_follows?: boolean;
                                hide_follows_count?: boolean;
                                id: string;
                                identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                                indexable: boolean | null;
                                is_admin?: boolean;
                                is_cat: boolean;
                                is_moderator?: boolean;
                                is_suggested?: boolean;
                                last_status_at: string | null;
                                limited?: boolean;
                                local?: boolean;
                                location?: string;
                                locked: boolean;
                                memorial: boolean | null;
                                mention_policy: "none" | "only_known" | "only_contacts";
                                noindex: boolean | null;
                                note: string;
                                payment_options: ((...) | (...))[];
                                permit_followback?: boolean;
                                pronouns: string[];
                                relationship?: {
                                    blocked_by: ...;
                                    blocking: ...;
                                    domain_blocking: ...;
                                    endorsed: ...;
                                    followed_by: ...;
                                    following: ...;
                                    id: ...;
                                    languages: ...;
                                    muting: ...;
                                    muting_notifications: ...;
                                    note: ...;
                                    notifying: ...;
                                    requested: ...;
                                    showing_reblogs: ...;
                                };
                                roles: {
                                    color: ...;
                                    highlighted: ...;
                                    id: ...;
                                    name: ...;
                                    permissions: ...;
                                }[];
                                speak_as_cat: boolean;
                                statuses_count: number;
                                subscribers_count: number;
                                suspended?: boolean;
                                url: string;
                                username: string;
                                verified?: boolean;
                            }
                            | null;
                        noindex: boolean
                        | null;
                        note: string;
                        payment_options: (
                            | {
                                href: (...)
                                | (...);
                                name: (...) | (...);
                                object_id: (...) | (...);
                                type: "link";
                            }
                            | {
                                amount_min: (...)
                                | (...);
                                chain_id: (...) | (...);
                                object_id: (...) | (...);
                                price: (...) | (...);
                                type: "monero-subscription";
                            }
                        )[];
                        permit_followback?: boolean;
                        pronouns: string[];
                        relationship?: {
                            blocked_by: boolean;
                            blocking: boolean;
                            domain_blocking: boolean;
                            endorsed: boolean;
                            followed_by: boolean;
                            following: boolean;
                            id: string;
                            languages: (...)[]
                            | null;
                            muting: boolean;
                            muting_notifications: boolean;
                            note: string;
                            notifying: boolean;
                            requested: boolean;
                            showing_reblogs: boolean;
                        };
                        roles: {
                            color: string;
                            highlighted: boolean;
                            id: string;
                            name: string;
                            permissions: string;
                        }[];
                        speak_as_cat: boolean;
                        statuses_count: number;
                        subscribers_count: number;
                        suspended?: boolean;
                        url: string;
                        username: string;
                        verified?: boolean;
                    } & WithMoved;
                    participation_message: string;
                },
                true,
            >,
        >

        Gets event participation requests

      • getEventParticipations: (
            statusId: string,
            params?: PaginationParams,
        ) => Promise<PaginatedResponse<Account, true>>

        Gets event participants

      • getJoinedEvents: (
            state?: "pending" | "reject" | "accept",
            params?: PaginationParams,
        ) => Promise<PaginatedResponse<Status, true>>

        Gets user's joined events

      • joinEvent: (statusId: string, participation_message?: string) => Promise<Status>

        Joins the event

      • leaveEvent: (statusId: string) => Promise<Status>

        Leaves the event

      • rejectEventParticipationRequest: (statusId: string, accountId: string) => Promise<Status>

        Rejects user from the event