Documentation

Class: h5/ugc

h5/ugc

new h5/ugc()

Creates a ugc object

Members

_http

Initializes a new HttpWrapper with API Key

Methods

playerGameVariant(player, variant)

Returns Player Game Variant.
https://developer.haloapi.com/docs/services/58acde2921091812784ce8c3/operations/58acde292109180bdcacc40c?
Parameters:
Name Type Description
player string Player
variant string Variant (ID)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.ugc.playerGameVariant('player', 'ID').then( (variant) => {
  //Do code here
});

playerGameVariants(player, start, count, sort, order)

Returns Player Game Variants.
https://developer.haloapi.com/docs/services/58acde2921091812784ce8c3/operations/58acde292109180bdcacc40d?
Parameters:
Name Type Description
player string Player
start number Starting Index (Default 0)
count number Count (Default 100)
sort number Sort (Default Modified)
order string Order (Default desc)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.ugc.playerGameVariants('player', 0, 100, 'modified', 'desc').then( (variants) => {
  //Do code here
});

playerMapVariant(player, variant)

Returns Player Map Variant.
https://developer.haloapi.com/docs/services/58acde2921091812784ce8c3/operations/58acde292109180bdcacc40e?
Parameters:
Name Type Description
player string Player
variant string Variant ID
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.ugc.playerMapVariant('player', 'variantID').then( (variant) => {
  //Do code here
});

playerMapVariants(player, start, count, sort, order)

Returns Player Map Variants.
https://developer.haloapi.com/docs/services/58acde2921091812784ce8c3/operations/58acde292109180bdcacc40f?
Parameters:
Name Type Description
player string Player
start number Starting Index (Default 0)
count number Count (Default 100)
sort number Sort (Default Modified)
order string Order (Default desc)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.ugc.playerMapVariants('player', 0, 100, 'modified', 'desc').then( (variants) => {
  //Do code here
});