Skip to main content
Module

x/bnapi/mod.ts>wow.characterProfileStatus

Blizzard Battle.net API wrapper for Deno.
Go to Latest
function wow.characterProfileStatus
import { wow } from "https://deno.land/x/bnapi@0.9/mod.ts";
const { characterProfileStatus } = wow;

Returns the status and a unique ID for a character.

A client should delete information about a character from their application if any of the following conditions occur:

  • an HTTP 404 Not Found error is returned
  • the is_valid value is false
  • the returned character ID doesn't match the previously recorded value for the character

The following example illustrates how to use this endpoint:

  1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
  2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
  3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
  4. If the character is valid and the character IDs match, the client retains the data for another 30 days.

Parameters

realmSlug: string
characterName: string

Returns

Promise<CharacterProfileStatus>