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