2

Wii U BOSS API

Jay edited this page 2020-11-30 22:00:24 -06:00

Table of Contents

• Note
• Methods
• isRegisteredBossTask()
• unregisterBossTask()
• registerDirectMessageTaskEx(lifeTime, interval)
• unregisterDirectMessageTask()
• registerDirectMessageTask()
• registerBossTask(languageCode)
• isRegisteredDirectMessageTask()

wiiuBOSS is a global JavaScript object that exposes an API for interacting with the system BOSS (SpotPass) API.

Note

Most of this is assumptions based on observed behavior during testing or examples of usage found in dumps of the original Miiverse Javascript file. We do not know enough about how BOSS works at this time to completely understand what the system is trying to do. This document will be updated as we find out more.

Methods

isRegisteredBossTask()

• Returns: {JSON Document}

• Example:

  • { isRegistered: false }

• Usage:

  checks if something(?) is a registered BOSS task

unregisterBossTask()

• Returns: {JSON Document}

• Examples:

  • {}

• Usage:

  unregisters something as a BOSS task

registerDirectMessageTaskEx(lifeTime, interval)

• Arguments:

  • {int(?)}
  • {int(?)}

• Returns: {JSON Document}

• Example:

  • {}

• Usage:

  register a direct message task with a specific lifetime to be run at a specific interval

• Notes:

  • Calling the function will sometimes make a network request to `(miiverse api domain}/v1/users/(pid)/notifications

unregisterDirectMessageTask()

• Returns: {JSON Document}

• Examples:

  • {}

• Usage:

  unregister a direct message task with BOSS

registerDirectMessageTask()

• Returns: {JSON Document}

• Example:

  • {}

• Usage:

  register a direct message task

• Notes:

  • Calling the function will sometimes make a network request to `(miiverse api domain}/v1/users/(pid)/notifications

registerBossTask(languageCode)

• Arguments:

  • {unknown}

• Returns: {JSON Document}

• Examples:

  • {}

• Usage:

  Makes a network request to https://npts.app.nintendo.net/p01/tasksheet/1/VFoY6V7u7UUq1EG5/olvinfo?c=US&l=[Language Code] which responds with

  <?xml version="1.0" encoding="UTF-8"?>
  <TaskSheet>
    <TitleId>0005003010016100</TitleId>
    <TaskId>olvinfo</TaskId>
    <ServiceStatus>open</ServiceStatus>
    <Files>
    </Files>
  </TaskSheet>
  

isRegisteredDirectMessageTask()

• Returns: {JSON Document}

• Example:

  • { isRegistered: false }

• Usage:

  checks if there is currently a registed direct message task