@folderharbor/sdk
    Preparing search index...

    Class MeResource

    Methods for reading and changing the authenticated user's info.

    Constructors

    Methods

    • Updates the current user's information.

      Parameters

      • body: FHSelfInfoEdit

        The information you want to change / updates you want to make

      Returns Promise<void>

      If your session is invalid, expired, or for a locked account

      If anything else went wrong, either in the process of requesting, or in the response from the server

      await client.me.edit({ username: "meow", password: "mrrp", clearLoginAttempts: true });
      
    • Gets the current user's information.

      Returns Promise<FHSelfInfo>

      Information about the logged in user

      If your session is invalid, expired, or for a locked account

      If anything else went wrong, either in the process of requesting, or in the response from the server

      const info = await client.me.info();
      
    • Revokes a session token for the current user.

      Parameters

      • sessionID: number

        The session ID for the session you want to revoke

      Returns Promise<void>

      If your session is invalid, expired, or for a locked account

      If anything else went wrong, either in the process of requesting, or in the response from the server

      await client.me.revokeSession(6);