C_Club

namespaceavailable in: camelot

Status in wowlua

84 functions: 9 implemented, 2 recorded, 73 guessed. 30 events, 1 of them fired by the emulator on its own.

Functions

function	what it does	status
`AcceptInvitation`	Accepts an invitation to a community. · by wowlua `(clubId: ClubId)`	guessed
`AddClubStreamChatChannel`	Adds a communities channel. `(clubId: ClubId, streamId: ClubStreamId)`	guessed
`AdvanceStreamViewMarker`	Marks a community stream as read up to now. · by wowlua `(clubId: ClubId, streamId: ClubStreamId)`	guessed
`AreMembersReady`	Whether the community's member list has been loaded. · by wowlua `(clubId: ClubId): boolean`	implemented
`AssignMemberRole`	Gives a community member a role, such as moderator. · by wowlua `(clubId: ClubId, memberId: ClubMemberOpaqueId, roleId: ClubRoleIdentifier)`	guessed
`CanResolvePlayerLocationFromClubMessageData`	Whether the sender of a community message can be found as a player. · by wowlua `(clubId: ClubId, streamId: ClubStreamId, epoch: number, position: number): boolean`	guessed
`ClearAutoAdvanceStreamViewMarker`	Stops marking a community stream as read automatically. · by wowlua `()`	guessed
`ClearClubPresenceSubscription`	Stops receiving online status updates of a community's members. · by wowlua `()`	guessed
`CompareBattleNetDisplayName`	Compares two community members by Battle.net name, for sorting. · by wowlua `(clubId: ClubId, lhsMemberId: number, rhsMemberId: number): number`	guessed
`CreateClub`	Creates a community. · by wowlua `(name: string, shortName: string?, description: string, clubType: ClubType, avatarId: number, isCrossFaction: boolean?)`	guessed
`CreateStream`	Check the canCreateStream privilege. `(clubId: ClubId, name: string, subject: string, leadersAndModeratorsOnly: boolean)`	guessed
`CreateTicket`	This is protected and only available to the Blizzard UI. Used for creating a ticket for a community club. `(clubId: ClubId, allowedRedeemCount: number?, duration: number?, defaultStreamId: ClubStreamId?, isCrossFaction: boolean?)`	guessed
`DeclineInvitation`	Declines an invitation to a community. · by wowlua `(clubId: ClubId)`	guessed
`DestroyClub`	Check the canDestroy privilege. `(clubId: ClubId)`	guessed
`DestroyMessage`	Deletes a message in a community stream. · by wowlua `(clubId: ClubId, streamId: ClubStreamId, messageId: ClubMessageIdentifier)`	guessed
`DestroyStream`	Check canDestroyStream privilege. `(clubId: ClubId, streamId: ClubStreamId)`	guessed
`DestroyTicket`	Check canDestroyTicket privilege. `(clubId: ClubId, ticketId: string)`	guessed
`DoesAnyCommunityHaveUnreadMessages`	Whether any of the player's communities has unread messages. · by wowlua `(): boolean`	guessed
`DoesCommunityHaveMembersOfTheOppositeFaction`	Whether the community has members of the other faction. · by wowlua `(clubId: ClubId): boolean`	guessed
`EditClub`	nil arguments will not change existing club data `(clubId: ClubId, name: string?, shortName: string?, description: string?, avatarId: number?, broadcast: string?, crossFaction: boolean?)`	guessed
`EditMessage`	Changes the text of a message in a community stream. · by wowlua `(clubId: ClubId, streamId: ClubStreamId, messageId: ClubMessageIdentifier, message: string)`	guessed
`EditStream`	Check the canSetStreamName, canSetStreamSubject, canSetStreamAccess privileges. nil arguments will not change existing stream data. `(clubId: ClubId, streamId: ClubStreamId, name: string?, subject: string?, leadersAndModeratorsOnly: boolean?)`	guessed
`Flush`	Sends the community changes that are waiting to the server. · by wowlua `()`	guessed
`FocusCommunityStreams`	Starts receiving the messages of the communities' streams. · by wowlua `()`	guessed
`FocusMembers`	Starts receiving updates of a community's members. · by wowlua `(clubId: ClubId)`	guessed
`FocusStream`	Starts receiving a community stream's messages and returns whether it worked. · by wowlua `(clubId: ClubId, streamId: ClubStreamId): boolean`	guessed
`GetAssignableRoles`	Returns the roles a community member can be given. · by wowlua `(clubId: ClubId, memberId: ClubMemberOpaqueId): ClubRoleIdentifier[]`	guessed
`GetAvatarIdList`	listen for AVATAR_LIST_UPDATED event. This can happen if we haven't downloaded the battle.net avatar list yet `(clubType: ClubType): number[]?`	guessed
`GetClubCapacity`	Returns how many members a community can have. · by wowlua `(): number`	guessed
`GetClubInfo`	Returns information about a community, or nil. · by wowlua `(clubId: ClubId): ClubInfo?`	implemented
`GetClubLimits`	Returns the limits of a community type, such as how many streams it can have. · by wowlua `(clubType: ClubType): ClubLimits`	guessed
`GetClubMembers`	Returns the member IDs of a community, or of those who can see one of its streams. · by wowlua `(clubId: ClubId, streamId: ClubStreamId?): ClubMemberOpaqueId[]`	implemented
`GetClubPrivileges`	The privileges for the logged in user for this club `(clubId: ClubId): ClubPrivilegeInfo`	guessed
`GetClubStreamNotificationSettings`	Returns the notification settings of a community's streams. · by wowlua `(clubId: ClubId): ClubStreamNotificationSetting[]`	guessed
`GetCommunityNameResultText`	Returns the message that explains a name check's result, or nil. · by wowlua `(result: ValidateNameResult): string?`	guessed
`GetGuildClubId`	Returns the community ID of the player's guild, or nil outside a guild. · by wowlua `(): ClubId?`	implemented
`GetInfoFromLastCommunityChatLine`	Returns the message, community, stream and community type of the last community chat line. · by wowlua `(): (ClubMessageInfo?, ClubId?, ClubStreamId?, ClubType?)`	guessed
`GetInvitationCandidates`	Returns a list of players that you can send a request to a Battle.net club. Returns an empty list for Character based clubs `(filter: string?, maxResults: number?, cursorPosition: number?, allowFullMatch: boolean?, clubId: ClubId): ClubInvitationCandidateInfo[]`	guessed
`GetInvitationInfo`	Get info about a specific club the active player has been invited to. `(clubId: ClubId): ClubSelfInvitationInfo?`	guessed
`GetInvitationsForClub`	Get the pending invitations for this club. Call RequestInvitationsForClub() to retrieve invitations from server. `(clubId: ClubId): ClubInvitationInfo[]`	guessed
`GetInvitationsForSelf`	These are the clubs the active player has been invited to. `(): ClubSelfInvitationInfo[]`	recorded
`GetLastTicketResponse`	Returns the server's last answer about a community invite link: an error, the community, and more. · by wowlua `(ticket: string): (ClubErrorType?, ClubInfo?, boolean?)`	guessed
`GetMemberInfo`	Returns information about a community member, or nil. · by wowlua `(clubId: ClubId, memberId: ClubMemberOpaqueId): ClubMemberInfo?`	implemented
`GetMemberInfoForSelf`	Info for the logged in user for this club `(clubId: ClubId): ClubMemberInfo?`	implemented
`GetMessageInfo`	Get info about a particular message. `(clubId: ClubId, streamId: ClubStreamId, messageId: ClubMessageIdentifier): ClubMessageInfo?`	guessed
`GetMessageRanges`	Get the ranges of the messages currently downloaded. `(clubId: ClubId, streamId: ClubStreamId): ClubMessageRange[]`	guessed
`GetMessagesBefore`	Get downloaded messages before (and including) the specified messageId limited by count. These are filtered by ignored players `(clubId: ClubId, streamId: ClubStreamId, newest: ClubMessageIdentifier, count: number): ClubMessageInfo[]`	guessed
`GetMessagesInRange`	Get downloaded messages in the given range. These are filtered by ignored players `(clubId: ClubId, streamId: ClubStreamId, oldest: ClubMessageIdentifier, newest: ClubMessageIdentifier): ClubMessageInfo[]`	guessed
`GetStreamInfo`	Returns information about a community stream, or nil. · by wowlua `(clubId: ClubId, streamId: ClubStreamId): ClubStreamInfo?`	implemented
`GetStreamViewMarker`	Returns the time up to which a community stream has been read, or nil. · by wowlua `(clubId: ClubId, streamId: ClubStreamId): number?`	guessed
`GetStreams`	Returns a community's chat streams. · by wowlua `(clubId: ClubId): ClubStreamInfo[]`	implemented
`GetSubscribedClubs`	Returns the communities the player is a member of, the guild included. · by wowlua `(): ClubInfo[]`	implemented
`GetTickets`	Get the existing tickets for this club. Call RequestTickets() to retrieve tickets from server. `(clubId: ClubId): ClubTicketInfo[]`	guessed
`IsAccountMuted`	Whether the player's account is muted in the community. · by wowlua `(clubId: ClubId): boolean`	guessed
`IsBeginningOfStream`	Returns whether the given message is the first message in the stream, taking into account ignored messages `(clubId: ClubId, streamId: ClubStreamId, messageId: ClubMessageIdentifier): boolean`	guessed
`IsEnabled`	Whether communities are enabled. · by wowlua `(): boolean`	recorded
`IsRestricted`	Returns why communities are restricted for the player, or that they are not. · by wowlua `(): ClubRestrictionReason`	guessed
`IsSubscribedToStream`	Whether the player receives the messages of a community stream. · by wowlua `(clubId: ClubId, streamId: ClubStreamId): boolean`	guessed
`KickMember`	Check kickableRoleIds privilege. `(clubId: ClubId, memberId: ClubMemberOpaqueId)`	guessed
`LeaveClub`	Leaves a community. · by wowlua `(clubId: ClubId)`	guessed
`RedeemTicket`	Joins a community through an invite link. · by wowlua `(ticketId: string)`	guessed
`RequestInvitationsForClub`	Request invitations for this club from server. Check canGetInvitation privilege. `(clubId: ClubId)`	guessed
`RequestMoreMessagesBefore`	Call this when the user scrolls near the top of the message view, and more need to be displayed. The history will be downloaded backwards (newest to oldest). `(clubId: ClubId, streamId: ClubStreamId, messageId: ClubMessageIdentifier?, count: number?): boolean`	guessed
`RequestTicket`	Asks the server for information about a community invite link. · by wowlua `(ticketId: string)`	guessed
`RequestTickets`	Request tickets from server. Check canGetTicket privilege. `(clubId: ClubId)`	guessed
`RevokeInvitation`	Check canRevokeOwnInvitation or canRevokeOtherInvitation `(clubId: ClubId, memberId: ClubMemberOpaqueId)`	guessed
`SendBattleTagFriendRequest`	Sends a BattleTag friend request to a guild member. · by wowlua `(guildClubId: ClubId, memberId: ClubMemberOpaqueId)`	guessed
`SendCharacterInvitation`	Invites a character to a community. · by wowlua `(clubId: ClubId, character: string)`	guessed
`SendInvitation`	Check the canSendInvitation privilege. `(clubId: ClubId, memberId: ClubMemberOpaqueId)`	guessed
`SendMessage`	This is a protected function and will not work via addons. Used to send message to Club Stream. `(clubId: ClubId, streamId: ClubStreamId, message: string)`	guessed
`SendTitleFriendRequest`	Sends an in-game friend request to a guild member. · by wowlua `(guildClubId: ClubId, memberId: ClubMemberOpaqueId)`	guessed
`SetAutoAdvanceStreamViewMarker`	Only one stream can be set for auto-advance at a time. Focused streams will have their view times advanced automatically. `(clubId: ClubId, streamId: ClubStreamId)`	guessed
`SetAvatarTexture`	Sets a texture to a community avatar. · by wowlua `(texture: Texture, avatarId: number, clubType: ClubType)`	guessed
`SetClubMemberNote`	Check the canSetOwnMemberNote and canSetOtherMemberNote privileges. `(clubId: ClubId, memberId: ClubMemberOpaqueId, note: string)`	guessed
`SetClubPresenceSubscription`	You can only be subscribed to 0 or 1 clubs for presence. Subscribing to a new club automatically unsuscribes you to existing subscription. `(clubId: ClubId)`	guessed
`SetClubStreamNotificationSettings`	Sets the notification settings of a community's streams. · by wowlua `(clubId: ClubId, settings: ClubStreamNotificationSetting[])`	guessed
`SetCommunityID`	Sets the community ID used by the community interface. · by wowlua `(communityID: number)`	guessed
`SetFavorite`	Marks or unmarks a community as a favorite. · by wowlua `(clubId: ClubId, isFavorite: boolean)`	guessed
`SetSocialQueueingEnabled`	Sets whether the community's members see the player's group finder listings. · by wowlua `(clubId: ClubId, enabled: boolean)`	guessed
`ShouldAllowClubType`	Whether communities of the type can be used. · by wowlua `(clubType: ClubType): boolean`	guessed
`UnfocusAllStreams`	Stops receiving the messages of all focused community streams. · by wowlua `(unsubscribe: boolean)`	guessed
`UnfocusMembers`	Stops receiving updates of a community's members. · by wowlua `(clubId: ClubId)`	guessed
`UnfocusStream`	Stops receiving a community stream's messages. · by wowlua `(clubId: ClubId, streamId: ClubStreamId)`	guessed
`ValidateText`	Checks whether a text can be used for a community field, such as its name, and returns the result. · by wowlua `(clubType: ClubType, text: string, clubFieldType: ClubFieldType): ValidateNameResult`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`AVATAR_LIST_UPDATED`	`clubType: ClubType`	not implemented
`CLUB_ADDED`	`clubId: ClubId`	not implemented
`CLUB_ERROR`	`action: ClubActionType, error: ClubErrorType, clubType: ClubType`	not implemented
`CLUB_INVITATIONS_RECEIVED_FOR_CLUB`	`clubId: ClubId`	not implemented
`CLUB_INVITATION_ADDED_FOR_SELF`	`invitation: ClubSelfInvitationInfo`	not implemented
`CLUB_INVITATION_REMOVED_FOR_SELF`	`invitationId: ClubInvitationId`	not implemented
`CLUB_MEMBERS_UPDATED`	`clubId: ClubId`	not implemented
`CLUB_MEMBER_ADDED`	`clubId: ClubId, memberId: ClubMemberOpaqueId`	not implemented
`CLUB_MEMBER_PRESENCE_UPDATED`	`clubId: ClubId, memberId: ClubMemberOpaqueId, presence: ClubMemberPresence`	not implemented
`CLUB_MEMBER_REMOVED`	`clubId: ClubId, memberId: ClubMemberOpaqueId`	not implemented
`CLUB_MEMBER_ROLE_UPDATED`	`clubId: ClubId, memberId: ClubMemberOpaqueId, roleId: number`	not implemented
`CLUB_MEMBER_UPDATED`	`clubId: ClubId, memberId: ClubMemberOpaqueId`	not implemented
`CLUB_MESSAGE_ADDED`	`clubId: ClubId, streamId: ClubStreamId, messageId: ClubMessageIdentifier`	not implemented
`CLUB_MESSAGE_HISTORY_RECEIVED`	`clubId: ClubId, streamId: ClubStreamId, downloadedRange: ClubMessageRange, contiguousRange: ClubMessageRange`	not implemented
`CLUB_MESSAGE_UPDATED`	`clubId: ClubId, streamId: ClubStreamId, messageId: ClubMessageIdentifier`	not implemented
`CLUB_REMOVED`	`clubId: ClubId`	not implemented
`CLUB_REMOVED_MESSAGE`	`clubName: string, clubRemovedReason: ClubRemovedReason`	not implemented
`CLUB_SELF_MEMBER_ROLE_UPDATED`	`clubId: ClubId, roleId: number`	not implemented
`CLUB_STREAMS_LOADED`	`clubId: ClubId`	not implemented
`CLUB_STREAM_ADDED`	`clubId: ClubId, streamId: ClubStreamId`	not implemented
`CLUB_STREAM_REMOVED`	`clubId: ClubId, streamId: ClubStreamId`	not implemented
`CLUB_STREAM_SUBSCRIBED`	`clubId: ClubId, streamId: ClubStreamId`	not implemented
`CLUB_STREAM_UNSUBSCRIBED`	`clubId: ClubId, streamId: ClubStreamId`	not implemented
`CLUB_STREAM_UPDATED`	`clubId: ClubId, streamId: ClubStreamId`	not implemented
`CLUB_TICKETS_RECEIVED`	`clubId: ClubId`	not implemented
`CLUB_TICKET_CREATED`	`clubId: ClubId, ticketInfo: ClubTicketInfo`	not implemented
`CLUB_TICKET_RECEIVED`	`ticket: string`	not implemented
`CLUB_UPDATED`	`clubId: ClubId`	not implemented
`INITIAL_CLUBS_LOADED`	`no payload`	implemented
`STREAM_VIEW_MARKER_UPDATED`	`clubId: ClubId, streamId: ClubStreamId, lastReadTime: number?`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("AVATAR_LIST_UPDATED").

Structures

ClubInfo · clubId, name, shortName?, description, broadcast, clubType, avatarId, memberCount?, favoriteTimeStamp?, joinTime?, socialQueueingEnabled?, crossFaction?
ClubInvitationCandidateInfo · memberId, name, priority, status
ClubInvitationInfo · invitationId, isMyInvitation, invitee
ClubLimits · maximumNumberOfStreams
ClubMemberInfo · isSelf, memberId, name?, role?, presence, clubType?, guid?, bnetAccountId?, memberNote?, officerNote?, classID?, race?, level?, zone?, achievementPoints?, profession1ID?, profession1Rank?, profession1Name?, profession2ID?, profession2Rank?, profession2Name?, lastOnlineYear?, lastOnlineMonth?, lastOnlineDay?, lastOnlineHour?, guildRank?, guildRankOrder?, isRemoteChat?, overallDungeonScore?, faction?, timerunningSeasonID?, discordInfo?
ClubMessageIdentifier · epoch, position
ClubMessageInfo · messageId, content, author, destroyer?, destroyed, edited
ClubMessageRange · oldestMessageId, newestMessageId
ClubPrivilegeInfo · canDestroy, canSetAttribute, canSetName, canSetDescription, canSetAvatar, canSetBroadcast, canSetPrivacyLevel, canSetOwnMemberAttribute, canSetOtherMemberAttribute, canSetOwnMemberNote, canSetOtherMemberNote, canSetOwnVoiceState, canSetOwnPresenceLevel, canUseVoice, canVoiceMuteMemberForAll, canGetInvitation, canSendInvitation, canSendGuestInvitation, canRevokeOwnInvitation, canRevokeOtherInvitation, canGetBan, canGetSuggestion, canSuggestMember, canGetTicket, canCreateTicket, canDestroyTicket, canAddBan, canRemoveBan, canCreateStream, canDestroyStream, canSetStreamPosition, canSetStreamAttribute, canSetStreamName, canSetStreamSubject, canSetStreamAccess, canSetStreamVoiceLevel, canCreateMessage, canDestroyOwnMessage, canDestroyOtherMessage, canEditOwnMessage, canPinMessage, kickableRoleIds
ClubRoleInfo · roleId, name, required, unique
ClubSelfInvitationInfo · invitationId, club, inviter, leaders
ClubStreamInfo · streamId, name, subject, leadersAndModeratorsOnly, streamType, creationTime
ClubStreamNotificationSetting · streamId, filter
ClubTicketInfo · ticketId, allowedRedeemCount, currentRedeemCount, creationTime, expirationTime, defaultStreamId?, creator

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (Club system, camelot 1.60.1). Descriptions: Blizzard's API documentation (Blizzard_APIDocumentationGenerated); warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.