Class GroupId
The Group class is a data model representing an identifier for a Group within the social platform.
Inherited Members
Namespace: EPiServer.Social.Groups.Core
Assembly: EPiServer.Social.Groups.Core.dll
Version: 1.5.4Syntax
public class GroupId : IdentifierConstructors
GroupId(String)
Constructor
Declaration
public GroupId(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | String-based identifier for a group |
Properties
Empty
Returns a newly created Group instance representing an 'empty' group ID.
Declaration
public static GroupId Empty { get; }Property Value
| Type | Description |
|---|---|
| GroupId |
Methods
Create()
Creates an empty Group.
Declaration
public static GroupId Create()Returns
| Type | Description |
|---|---|
| GroupId | Empty Group instance |
Create(String)
Parses a group ID from a string-based identifier.
Declaration
public static GroupId Create(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifer for the group |
Returns
| Type | Description |
|---|---|
| GroupId | Instance of Group representing the specified identifier |
Equals(Object)
Compares this instance with another object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | the object to compare with this instance. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if this instance and another specified object, of type Group have the same value of the underlying comment identifier, else returns false. |
Overrides
GetHashCode()
Returns a hash code representative of this Group.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | A 32-bit signed integer hash code. |
Overrides
IsNullOrEmpty(GroupId)
Returns true if the specified Group has not been initialized or represents an empty group identifier, false otherwise.
Declaration
public static bool IsNullOrEmpty(GroupId id)Parameters
| Type | Name | Description |
|---|---|---|
| GroupId | id | Group identifier to evaluate |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the Group is null or empty, false otherwise |
Operators
Equality(GroupId, GroupId)
Evaluates the equality of two Group instances.
Declaration
public static bool operator ==(GroupId a, GroupId b)Parameters
| Type | Name | Description |
|---|---|---|
| GroupId | a | The operand on the left side of the equality operator. |
| GroupId | b | The operand on the right side of the equality operator. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the specified instances are equivalent, false otherwise. |
Inequality(GroupId, GroupId)
Evaluates two Group instances for inequality.
Declaration
public static bool operator !=(GroupId a, GroupId b)Parameters
| Type | Name | Description |
|---|---|---|
| GroupId | a | The operand on the left side of the inequality operator. |
| GroupId | b | The operand on the right side of the inequality operator. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the specified instances are not equivalent, false otherwise. |