2024-11-17 23:35:40 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > PokerogueAccountApi | pokemon-rogue-battle< / title > < meta name = "description" content = "Documentation for pokemon-rogue-battle" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script defer src = "../assets/main.js" > < / script > < script async src = "../assets/icons.js" id = "tsd-icons-script" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < div class = "table-cell" id = "tsd-search" data-base = ".." > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget tsd-toolbar-icon search no-caption" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / label > < input type = "text" id = "tsd-search-field" aria-label = "Search" / > < / div > < div class = "field" > < div id = "tsd-toolbar-links" > < / div > < / div > < ul class = "results" > < li class = "state loading" > Preparing search index...< / li > < li class = "state failure" > The search index is not available< / li > < / ul > < a href = "../index.html" class = "title" > pokemon-rogue-battle< / a > < / div > < div class = "table-cell" id = "tsd-widgets" > < a href = "#" class = "tsd-widget tsd-toolbar-icon menu no-caption" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" > < li > < a href = "../index.html" > pokemon-rogue-battle< / a > < / li > < li > < a href = "../modules/plugins_api_pokerogue_account_api.html" > plugins/api/pokerogue-account-api< / a > < / li > < li > < a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html" > PokerogueAccountApi< / a > < / li > < / ul > < h1 > Class PokerogueAccountApi< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > A wrapper for PokéRogue account API requests.< / p >
2024-11-18 18:42:56 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" > < h4 > Hierarchy (< a href = "../hierarchy.html#plugins/api/pokerogue-account-api.PokerogueAccountApi" > view full< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "plugins_api_api_base.ApiBase.html" class = "tsd-signature-type tsd-kind-class" > ApiBase< / a > < ul class = "tsd-hierarchy" > < li > < span class = "target" > PokerogueAccountApi< / span > < / li > < / ul > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/pokerogue-account-api.ts#L14" > src/plugins/api/pokerogue-account-api.ts:14< / a > < / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < h5 class = "tsd-index-heading uppercase" role = "button" aria-expanded = "false" tabIndex = "0" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-chevronSmall" > < / use > < / svg > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Constructors< / h3 > < div class = "tsd-index-list" > < a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#constructor" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a >
2024-11-17 23:35:40 +00:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#ERR_GENERIC" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > ERR_< wbr / > GENERIC< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#base" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > base< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#doFetch" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > do< wbr / > Fetch< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#doGet" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > do< wbr / > Get< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#doPost" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > do< wbr / > Post< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#getInfo" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Info< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#login" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > login< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#logout" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > logout< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#register" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > register< / span > < / a >
< a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#toUrlSearchParams" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > to< wbr / > Url< wbr / > Search< wbr / > Params< / span > < / a >
2024-11-18 18:42:56 +00:00
< / div > < / section > < / div > < / details > < / section > < / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Constructors" > < h2 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Constructors< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < a id = "constructor" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > constructor< / span > < a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "constructor.new_PokerogueAccountApi" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Pokerogue< wbr / > Account< wbr / > Api< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > base< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html" class = "tsd-signature-type tsd-kind-class" > PokerogueAccountApi< / a > < a href = "#constructor.new_PokerogueAccountApi" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > base< / span > : < span class = "tsd-signature-type" > string< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html" class = "tsd-signature-type tsd-kind-class" > PokerogueAccountApi< / a > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "plugins_api_api_base.ApiBase.html" > ApiBase< / a > .< a href = "plugins_api_api_base.ApiBase.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/api-base.ts#L15" > src/plugins/api/api-base.ts:15< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / details > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < h2 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "ERR_GENERIC" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Readonly< / code > < span > ERR_< wbr / > GENERIC< / span > < a href = "#ERR_GENERIC" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > ERR_< wbr / > GENERIC< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > = " There was an error" < / span > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "plugins_api_api_base.ApiBase.html" > ApiBase< / a > .< a href = "plugins_api_api_base.ApiBase.html#ERR_GENERIC" > ERR_GENERIC< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/api-base.ts#L9" > src/plugins/api/api-base.ts:9< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-is-protected tsd-is-inherited" > < a id = "base" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < code class = "tsd-tag" > Readonly< / code > < span > base< / span > < a href = "#base" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > base< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < p > I
2024-11-17 23:35:40 +00:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > path< / span > : < span class = "tsd-signature-type" > string< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > The path to send the request to.< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < span class = "tsd-kind-parameter" > config< / span > : < span class = "tsd-signature-type" > RequestInit< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > The request RequestInit | Configuration.< / p >
2024-11-18 18:42:56 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "plugins_api_api_base.ApiBase.html" > ApiBase< / a > .< a href = "plugins_api_api_base.ApiBase.html#doFetch" > doFetch< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/api-base.ts#L65" > src/plugins/api/api-base.ts:65< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-protected tsd-is-inherited" > < a id = "doGet" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < span > do< wbr / > Get< / span > < a href = "#doGet" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-protected tsd-is-inherited" > < li class = "tsd-signature tsd-anchor-link" > < a id = "doGet.doGet-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > do< wbr / > Get< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > path< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#doGet.doGet-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Send a GET request.< / p >
2024-11-17 23:35:40 +00:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > path< / span > : < span class = "tsd-signature-type" > string< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > The path to send the request to.< / p >
2024-11-18 18:42:56 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "plugins_api_api_base.ApiBase.html" > ApiBase< / a > .< a href = "plugins_api_api_base.ApiBase.html#doGet" > doGet< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/api-base.ts#L25" > src/plugins/api/api-base.ts:25< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-protected tsd-is-inherited" > < a id = "doPost" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < span > do< wbr / > Post< / span > < a href = "#doPost" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-protected tsd-is-inherited" > < li class = "tsd-signature tsd-anchor-link" > < a id = "doPost.doPost-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > do< wbr / > Post< / span > < span class = "tsd-signature-symbol" > < < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#doPost.doPost-1.D" > D< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > path< / span > , < span class = "tsd-kind-parameter" > bodyData< / span > < span class = "tsd-signature-symbol" > ?< / span > , < span class = "tsd-kind-parameter" > dataType< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#doPost.doPost-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Send a POST request.< / p >
2024-11-17 23:35:40 +00:00
< / div > < section class = "tsd-panel" > < h4 > Type Parameters< / h4 > < ul class = "tsd-type-parameter-list" > < li > < span > < a id = "doPost.doPost-1.D" class = "tsd-anchor" > < / a > < span class = "tsd-kind-type-parameter" > D< / span > = < span class = "tsd-signature-type" > undefined< / span > < / span > < / li > < / ul > < / section > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > path< / span > : < span class = "tsd-signature-type" > string< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > THe path to send the request to.< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > bodyData< / span > : < a class = "tsd-signature-type tsd-kind-type-parameter" href = "plugins_api_api_base.ApiBase.html#doPost.doPost-1.D" > D< / a > < / span > < div class = "tsd-comment tsd-typography" > < p > The body-data to send.< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < span class = "tsd-kind-parameter" > dataType< / span > : < span class = "tsd-signature-type" > DataType< / span > < span class = "tsd-signature-symbol" > = " json" < / span > < / span > < div class = "tsd-comment tsd-typography" > < p > The data-type of the bodyData.< / p >
2024-11-18 18:42:56 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Response< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "plugins_api_api_base.ApiBase.html" > ApiBase< / a > .< a href = "plugins_api_api_base.ApiBase.html#doPost" > doPost< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/api-base.ts#L35" > src/plugins/api/api-base.ts:35< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "getInfo" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > get< wbr / > Info< / span > < a href = "#getInfo" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "getInfo.getInfo-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > get< wbr / > Info< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > [< / span > data< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/_types_PokerogueAccountApi.AccountInfoResponse.html" class = "tsd-signature-type tsd-kind-interface" > AccountInfoResponse< / a > < span class = "tsd-signature-symbol" > , < / span > status< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ]< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#getInfo.getInfo-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Request the < a href = "../interfaces/_types_PokerogueAccountApi.AccountInfoResponse.html" class = "tsd-kind-interface" > < code > UserInfo< / code > < / a > of the logged in user.
2024-11-17 23:35:40 +00:00
The user is identified by the < a href = "../variables/constants.SESSION_ID_COOKIE_NAME.html" class = "tsd-kind-variable" > < code > session cookie< / code > < / a > .< / p >
2024-11-18 18:42:56 +00:00
< / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > [< / span > data< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/_types_PokerogueAccountApi.AccountInfoResponse.html" class = "tsd-signature-type tsd-kind-interface" > AccountInfoResponse< / a > < span class = "tsd-signature-symbol" > , < / span > status< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ]< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/pokerogue-account-api.ts#L21" > src/plugins/api/pokerogue-account-api.ts:21< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "login" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > login< / span > < a href = "#login" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "login.login-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > login< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > loginData< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#login.login-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Send a login request.
2024-11-17 23:35:40 +00:00
Sets the session cookie on success.< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > loginData< / span > : < a href = "../interfaces/_types_PokerogueAccountApi.AccountLoginRequest.html" class = "tsd-signature-type tsd-kind-interface" > AccountLoginRequest< / a > < / span > < div class = "tsd-comment tsd-typography" > < p > The < a href = "../interfaces/_types_PokerogueAccountApi.AccountLoginRequest.html" class = "tsd-kind-interface" > < code > AccountLoginRequest< / code > < / a > to send< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > An error message if something went wrong< / p >
2024-11-18 18:42:56 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/pokerogue-account-api.ts#L65" > src/plugins/api/pokerogue-account-api.ts:65< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "logout" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > logout< / span > < a href = "#logout" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "logout.logout-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > logout< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#logout.logout-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Send a logout request.
2024-11-17 23:35:40 +00:00
< strong > Always< / strong > (no matter if failed or not) removes the session cookie.< / p >
2024-11-18 18:42:56 +00:00
< / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/pokerogue-account-api.ts#L88" > src/plugins/api/pokerogue-account-api.ts:88< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "register" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > register< / span > < a href = "#register" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "register.register-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > register< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > registerData< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#register.register-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Register a new account.< / p >
2024-11-17 23:35:40 +00:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > registerData< / span > : < a href = "../interfaces/_types_PokerogueAccountApi.AccountRegisterRequest.html" class = "tsd-signature-type tsd-kind-interface" > AccountRegisterRequest< / a > < / span > < div class = "tsd-comment tsd-typography" > < p > The < a href = "../interfaces/_types_PokerogueAccountApi.AccountRegisterRequest.html" class = "tsd-kind-interface" > < code > AccountRegisterRequest< / code > < / a > to send< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > An error message if something went wrong< / p >
2024-11-18 18:42:56 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/pokerogue-account-api.ts#L43" > src/plugins/api/pokerogue-account-api.ts:43< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-protected tsd-is-inherited" > < a id = "toUrlSearchParams" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < span > to< wbr / > Url< wbr / > Search< wbr / > Params< / span > < a href = "#toUrlSearchParams" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-protected tsd-is-inherited" > < li class = "tsd-signature tsd-anchor-link" > < a id = "toUrlSearchParams.toUrlSearchParams-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > to< wbr / > Url< wbr / > Search< wbr / > Params< / span > < span class = "tsd-signature-symbol" > < < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "plugins_api_pokerogue_account_api.PokerogueAccountApi.html#toUrlSearchParams.toUrlSearchParams-1.D-1" > D< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > data< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > URLSearchParams< / span > < a href = "#toUrlSearchParams.toUrlSearchParams-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Helper to transform data to URLSearchParams
2024-11-17 23:35:40 +00:00
Any key with a value of < code > undefined< / code > will be ignored.
Any key with a value of < code > null< / code > will be included.< / p >
< / div > < section class = "tsd-panel" > < h4 > Type Parameters< / h4 > < ul class = "tsd-type-parameter-list" > < li > < span > < a id = "toUrlSearchParams.toUrlSearchParams-1.D-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-type-parameter" > D< / span > < span class = "tsd-signature-keyword" > extends < / span > < span class = "tsd-signature-type" > Record< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / span > < / li > < / ul > < / section > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > data< / span > : < a class = "tsd-signature-type tsd-kind-type-parameter" href = "plugins_api_api_base.ApiBase.html#toUrlSearchParams.toUrlSearchParams-1.D-1" > D< / a > < / span > < div class = "tsd-comment tsd-typography" > < p > the data to transform to URLSearchParams< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > URLSearchParams< / span > < / h4 > < p > a URLSearchParams representaton of data< / p >
2024-11-18 18:42:56 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "plugins_api_api_base.ApiBase.html" > ApiBase< / a > .< a href = "plugins_api_api_base.ApiBase.html#toUrlSearchParams" > toUrlSearchParams< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/plugins/api/api-base.ts#L86" > src/plugins/api/api-base.ts:86< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / details > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-accordion" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < span class = "settings-label" > Member Visibility< / span > < ul id = "tsd-filter-options" > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-protected" name = "protected" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Protected< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-external" name = "external" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > External< / span > < / label > < / li > < / ul > < / div > < div class = "tsd-theme-toggle" > < label class = "settings-label" for = "tsd-theme" > Theme< / label > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div > < details open class = "tsd-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "tsd-otp-Constructors" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Constructors< / summary > < div > < a href = "#constructor" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a > < / div > < / details > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "tsd-otp-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / summary > < div > < a href = "#ERR_GENERIC" class = "tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > ERR_< wbr / > GENERIC< / span > < / a > < a href = "#base" class = "tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > base< / span > < / a > < / div > < / details > < detai
