playfab_ex v0.2.0 PlayfabEx.Client.SharedGroupData

Link to this section Summary

Functions

Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide

Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, please see our guide

Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide

Link to this section Functions

Link to this function add_shared_group_members(params)
add_shared_group_members(map()) :: {:ok, map()} | {:error, String.t()}

Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide:

online docs

Link to this function create_shared_group(params)
create_shared_group(map()) :: {:ok, map()} | {:error, String.t()}

Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, please see our guide:

online docs

Link to this function get_shared_group_data(params)
get_shared_group_data(map()) :: {:ok, map()} | {:error, String.t()}

Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide:

online docs

Link to this function remove_shared_group_members(params)
remove_shared_group_members(map()) ::
  {:ok, map()} |
  {:error, String.t()}

online docs

Link to this function update_shared_group_data(params)
update_shared_group_data(map()) :: {:ok, map()} | {:error, String.t()}

online docs