Class UserManager

constructor

• new UserManager(client: client): UserManager

  Parameters

  • client: client

  Returns UserManager

holds

fetch

• fetch(
      user: UserResolvable,
      __namedParameters?: { force?: boolean },
  ): Promise<User>

  Parameters

  • user: UserResolvable

    The user to delete
  • __namedParameters: { force?: boolean } = {}

  Returns Promise<User>

  A promise that resolves when the user is deleted

resolve

• resolve(resolvable: User | Message): User

  get a user form cache

  Parameters

  • resolvable: User | Message

    The user to resolve

  Returns User

  The user or null if it cannot be resolved
• resolve(
      resolvable:
          | string
          | {
              _id: string;
              avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              badges?: number;
              bot?: null
              | { owner: string };
              discriminator: string;
              display_name?: null | string;
              flags?: number;
              online: boolean;
              privileged?: boolean;
              relations?: {
                  _id: string;
                  status:
                      | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
              }[];
              relationship: | "User"
              | "None"
              | "Friend"
              | "Outgoing"
              | "Incoming"
              | "Blocked"
              | "BlockedOther";
              status?: | null
              | {
                  presence?: null
                  | "Online"
                  | "Idle"
                  | "Focus"
                  | "Busy"
                  | "Invisible";
                  text?: null | string;
              };
              username: string;
          },
  ): null
  | User

  get a user form cache

  Parameters

  • resolvable:
        | string
        | {
            _id: string;
            avatar?: | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
            badges?: number;
            bot?: null
            | { owner: string };
            discriminator: string;
            display_name?: null | string;
            flags?: number;
            online: boolean;
            privileged?: boolean;
            relations?: {
                _id: string;
                status:
                    | "User"
                    | "None"
                    | "Friend"
                    | "Outgoing"
                    | "Incoming"
                    | "Blocked"
                    | "BlockedOther";
            }[];
            relationship: | "User"
            | "None"
            | "Friend"
            | "Outgoing"
            | "Incoming"
            | "Blocked"
            | "BlockedOther";
            status?: | null
            | {
                presence?: null
                | "Online"
                | "Idle"
                | "Focus"
                | "Busy"
                | "Invisible";
                text?: null | string;
            };
            username: string;
        }

    The user to resolve

    • string
    • {
          _id: string;
          avatar?:
              | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
          badges?: number;
          bot?: null
          | { owner: string };
          discriminator: string;
          display_name?: null | string;
          flags?: number;
          online: boolean;
          privileged?: boolean;
          relations?: {
              _id: string;
              status:
                  | "User"
                  | "None"
                  | "Friend"
                  | "Outgoing"
                  | "Incoming"
                  | "Blocked"
                  | "BlockedOther";
          }[];
          relationship: | "User"
          | "None"
          | "Friend"
          | "Outgoing"
          | "Incoming"
          | "Blocked"
          | "BlockedOther";
          status?: | null
          | {
              presence?: null
              | "Online"
              | "Idle"
              | "Focus"
              | "Busy"
              | "Invisible";
              text?: null | string;
          };
          username: string;
      }

      • _id: string

        Description

        Unique Id

      • Optionalavatar?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            }

        Description

        Avatar attachment

      • Optionalbadges?: number

        Format: uint32

        Description

        Bitfield of user badges

        https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserBadges.html

      • Optionalbot?: null | { owner: string }

        Description

        Bot information

      • discriminator: string

        Description

        Discriminator

      • Optionaldisplay_name?: null | string

        Description

        Display name

      • Optionalflags?: number

        Format: uint32

        Description

        Enum of user flags

        https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserFlags.html

      • online: boolean

        Description

        Whether this user is currently online

      • Optionalprivileged?: boolean

        Description

        Whether this user is privileged

      • Optionalrelations?: {
            _id: string;
            status:
                | "User"
                | "None"
                | "Friend"
                | "Outgoing"
                | "Incoming"
                | "Blocked"
                | "BlockedOther";
        }[]

        Description

        Relationships with other users

      • relationship:
            | "User"
            | "None"
            | "Friend"
            | "Outgoing"
            | "Incoming"
            | "Blocked"
            | "BlockedOther"

        Description

        Current session user's relationship with this user

      • Optionalstatus?:
            | null
            | {
                presence?: null
                | "Online"
                | "Idle"
                | "Focus"
                | "Busy"
                | "Invisible";
                text?: null | string;
            }

        Description

        User's current status

      • username: string

        Description

        Username

  Returns null | User

  The user or null if it cannot be resolved

resolveId

• resolveId(resolvable: UserResolvable): null | string

  get a user id form cache

  Parameters

  • resolvable: UserResolvable

    The user to resolve

  Returns null | string

  The user id or null if it cannot be resolved