elements_multi_match

Multi Match

The Multi Match endpoints.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_create_match
• elements_delete_all_matches
• elements_delete_match
• elements_get_match
• elements_get_matches
• elements_update_match

---

Back To Top

elements_create_match

This method accepts an instance of MultiMatch and creates a new DB entry for it. Though it is generally recommended to create a new MultiMatch via matchmaking code in an Element, it can be created via REST for the purposes of testing or custom workflows.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_match(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsMultiMatch	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMultiMatch or Undefined
_request	ElementsRequest

---

Back To Top

elements_delete_all_matches

Deletes and permanently removes all MultiMatches from he server. This effectively will cancel any pending request for a match. If a game is currently being played against the match, the server may reject the request to delete the match until the game concludes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_all_matches(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	ElementsRequest

---

Back To Top

elements_delete_match

Deletes and permanently removes the MultiMatch from he server. This effectively will cancel any pending request for a match. If a game is currently being played against the match, the server may reject the request to delete the match until the game concludes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_match(_match_id, _callback=undefined)

Argument	Type	Description
_match_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	ElementsRequest

---

Back To Top

elements_get_match

Gets a specific match given the match's unique ID. Additionally, it is possible to instruct the API to wait for a period of time before sending the response. The request will intentionally hang until the requested MultiMatch with ID has been updated in the database.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_match(_match_id, _callback=undefined)

Argument	Type	Description
_match_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMultiMatch or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_matches

Lists all matches available. Under most circumstances, this will requires that a profile be made available to the request. The server may choose to return an error if no suitable profile can be determined.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_matches(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationMultiMatch or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_match

This method accepts an instance of MultiMatch and updates the DB entry for it that matches the matchId. Though it is generally recommended to update a MultiMatch via matchmaking code in an Element, it can be updated via REST for the purposes of testing or custom workflows.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_match(_match_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_match_id	String
_body	ElementsMultiMatch	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMultiMatch or Undefined
_request	ElementsRequest

---