Club Class

Definition

Namespace:

Microsoft.Xbox.Services.Clubs

Assembly:

Microsoft.Xbox.Services.dll

C#

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Version(1)]
public sealed class Club

Inheritance

Object

Club

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.VersionAttribute

Properties

ActionSettings	Settings dictating what actions users can take within the club depending on their role.
BannerImageUrl	Club's background image url
Created	When the club was created.
FollowersCount	Number of followers of the club.
FounderXuid	Club founder's Xuid.
GlyphImageUrl	Club's display image url
Id	ClubId
IsClubSuspended	Whether or not the club is currently suspended.
MembersCount	Number of club members.
ModeratorsCount	Number of club moderators.
Owner	Club owner's Xuid
PresenceCount	Count of members present in the club.
PresenceTodayCount	Count of members present in the club today.
Profile	Configurable club attributes
RecommendedCount	Number of users recommended for the club.
ReportCount	Number of reports for the club.
ReporteItemsCount	Number of reported items for the club.
RequestedToJoinCount	Number of users requesting to join the club.
ShortName	Club short name
SuspendedUntil	When the club remains suspended until.
TitleFamilyId	Title family Id
TitleFamilyName	Localized Title Family Name
Type	Type (visibility) of club
ViewerRoles	Roles the viewer has in the club

Methods

AddClubModeratorAsync(String)	Promotes the specified user to moderator of the club. The specified user must already be a member of the club. Can only be called by the club owner.
AddUserToClubAsync()	Attempts to join a club. If the user has not yet been invited, this call will send a request to join the club which will need to be approved by a moderator before the caller becomes a member.
AddUserToClubAsync(String)	Depending on the role of the caller, this function will have a different effect: If the caller is a moderator of the club, the target user will be either invited or added as a club member immediately. In order for the target user to be added immediately, they have to have previously requested to join using the AddUserToClubAsync method. Moderators can examine the roster to get a list of users who have requested to join. If the caller is a member of the club, but not a moderator, the target user will be recommended for the club. For the user to be finally added as a member, AddUserToClubAsync still must be called by a club moderator AND AddUserToClubAsync must be called by the target user. Note: If the club doesn't support recommendations, an error will be returned. If the target user is the caller, this method will have the same exact behavior as AddUserToClubAsync()
BanUserFromClubAsync(String)	Bans the specified user from the club. Can only be called by club moderators or owner.
FollowClubAsync()	Adds the calling user as a follower of the specified club.
GetClubUserPresenceRecordsAsync()	Gets details about (at most) the last 1000 members active within a club.
GetPresenceCountsAsync()	Gets information about club member presence.
GetRoleRecordsAsync()	Returns records of the callers roles within the club.
GetRoleRecordsAsync(String)	Returns records for a given users roles within the club.
GetRolesAsync(String)	Returns the roles a given user has within the club.
GetRosterAsync()	Retrieves a roster of club members that have a special relationship with the club (something other than just member).
RemoveClubModeratorAsync(String)	Removes the specified user as a moderator of the club. They will retain there other roles within the club. Can only be called by the club owner.
RemoveUserFromClubAsync()	Deletes all relationships the calling user has with a club including: membership, outstanding invitations, recommendations to join, and following.
RemoveUserFromClubAsync(String)	Removes all relationships between the target user and the club including: membership, outstanding invitations/recommendations, and following. Can only be called by club moderator (or on yourself, which has the same effect as calling RemoveUserFromClubAsync())
RenameClubAsync(String)	Renames the club. Can only be called by the club owner. Some restrictions apply when renaming and public or private club; hidden clubs can be renamed freely. Note that the club object this is called from will not be updated with the new name even if this method is successful, but if the club object is retrieved again the new name will be reflected.
SetPresenceWithinClubAsync(ClubUserPresence)	Sets the user's presence within the club. This keeps track of which club page, if any, the user is currently viewing.
UnbanUserFromClubAsync(String)	Unbans the specified user from the club. Can only be called by club moderators or owner. Note: A similar affect can also be achieved by a moderator calling add_user_to_club. In that case however, banned users will immediately receive an invitation to the club in addition to being unbanned.
UnfollowClubAsync()	Removes the calling user as a follower of the specified club.

Applies to