nn::nex::Community Class

Syntax

class Community : public nn::nex::Gathering

Description

Stores community information. The community feature has been deprecated. We recommend using the equivalent persistent gathering feature, instead.

Member Functions

Community Constructor.
V ~Community Destructor.
Reset Initializes all set data.
SetCommunityType Sets the community type.
GetCommunityType Gets the community type.
SetPassword Sets a password when joining a community.
GetPassword Gets a password when joining a community.
SetAttribute Sets an attribute.
GetAttribute Gets an attribute.
SetApplicationBuffer Sets application-defined data.
GetApplicationBuffer Gets application-defined data.
SetParticipationStartDate Sets the date and time from which community participation is possible.
GetParticipationStartDate Gets the date and time from which community participation is possible.
SetParticipationEndDate Sets the end date for participation in this community.
GetParticipationEndDate Gets the end date for participation in this community.
GetMatchmakeSessionCount Gets the number of community matches associated with this community.
GetParticipationCount Gets the number of participants in this community.
GetID Gets the gathering ID. (Inherits Gathering.)
SetID Sets the gathering ID. (Inherits Gathering.)
V GetGatheringType Returns the class name of the gathering.
V IsA Determines whether an object has the class name specified by the argument.
V IsAKindOf Determines whether the object is of the class specified by the argument or inherits from that class.
SetDescription Sets a descriptive text string. (Inherits Gathering.)
GetDescription Gets the descriptive text string. (Inherits Gathering.)
GetOwnerPID Gets the PrincipalID of the owner of the gathering. (Inherits Gathering.)
GetHostPID Gets the principal ID of the gathering host. (Inherits Gathering.)
GetMinParticipants Gets the minimum number of participants for the gathering. (Inherits Gathering.)
GetMaxParticipants Gets the maximum number of participants for the gathering. (Inherits Gathering.)
SetMinParticipants Sets the minimum number of participants for the gathering. (Inherits Gathering.)
SetMaxParticipants Sets the maximum number of participants for the gathering. (Inherits Gathering.)
FlagIsSet Confirms whether the gathering flag has been set. (Inherits Gathering.)
SetFlag Sets the gathering flags enumerated in GatheringFlags. (Inherits Gathering.)
ClearFlag Clears the gathering flag. (Inherits Gathering.)

Class Hierarchy

nn::nex::RootObject
  nn::nex::Gathering
    nn::nex::Community

Revision History

2011/06/29
Initial version.

CONFIDENTIAL