Documentation
Home
SDKs
Cloud Save Economy Friends Leaderboards Remote Config Vivox Lobby Matchmaker Multiplay Player Authentication Player Names
Friends SDK 1.0
Version 1.0 Changelog

Relationships

Properties

Length

  • length: number

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Methods

[iterator]

[unscopables]

  • [unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

Concat

  • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

    Parameters

    • Rest ...items: ConcatArray<Relationship>[]

      Additional arrays and/or items to add to the end of the array.

    Returns Relationship[]

  • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

    Parameters

    • Rest ...items: (Relationship | ConcatArray<Relationship>)[]

      Additional arrays and/or items to add to the end of the array.

    Returns Relationship[]

Copy Within

  • copyWithin(target: number, start: number, end?: number): Relationships

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns Relationships

Entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Relationship]>

Every

  • Determines whether all the members of an array satisfy the specified test.

    Type parameters

    Parameters

    • predicate: (value: Relationship, index: number, array: Relationship[]) => value is S

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns this is S[]

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: Relationship, index: number, array: Relationship[]) => unknown

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

Fill

  • Changes all array elements from start to end index to a static value and returns the modified array

    Parameters

    • value: Relationship

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns Relationships

Filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • predicate: (value: Relationship, index: number, array: Relationship[]) => value is S

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: (value: Relationship, index: number, array: Relationship[]) => unknown

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns Relationship[]

Find

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: (value: Relationship, index: number, obj: Relationship[]) => value is S

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S

  • Parameters

    Returns Relationship

Find Index

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: Relationship, index: number, obj: Relationship[]) => unknown

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

For Each

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (value: Relationship, index: number, array: Relationship[]) => void

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

Includes

  • includes(searchElement: Relationship, fromIndex?: number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Relationship

      The element to search for.

    • Optional fromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

Index Of

  • indexOf(searchElement: Relationship, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

    Parameters

    • searchElement: Relationship

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

Join

  • join(separator?: string): string

  • Adds all the elements of an array into a string, separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

    Returns string

Keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

Last Index Of

  • lastIndexOf(searchElement: Relationship, fromIndex?: number): number

  • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

    Parameters

    • searchElement: Relationship

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

Map

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: (value: Relationship, index: number, array: Relationship[]) => U

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

Pop

  • Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns Relationship

Push

  • Appends new elements to the end of an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Relationship[]

      New elements to add to the array.

    Returns number

Reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Relationship

  • Parameters

    Returns Relationship

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: Relationship, currentIndex: number, array: Relationship[]) => U

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

Reduce Right

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Relationship

  • Parameters

    Returns Relationship

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: Relationship, currentIndex: number, array: Relationship[]) => U

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

Reverse

  • Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

    Returns Relationship[]

Shift

  • Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns Relationship

Slice

  • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

    Parameters

    • Optional start: number

      The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

    • Optional end: number

      The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

    Returns Relationship[]

Some

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: (value: Relationship, index: number, array: Relationship[]) => unknown

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

Sort

  • Sorts an array in place. This method mutates the array and returns a reference to the same array.

    Parameters

    • Optional compareFn: (a: Relationship, b: Relationship) => number

      Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      [11,2,22,1].sort((a, b) => a - b)

    Returns Relationships

Splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns Relationship[]

    An array containing the elements that were deleted.

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Relationship[]

      Elements to insert into the array in place of the deleted elements.

    Returns Relationship[]

    An array containing the elements that were deleted.

To Locale String

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

    Returns string

To String

  • toString(): string

  • Returns a string representation of an array.

    Returns string

Unshift

  • Inserts new elements at the start of an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Relationship[]

      Elements to insert at the start of the array.

    Returns number

Values

  • Returns an iterable of values in the array

    Returns IterableIterator<Relationship>