Class Subscription

This class represents a Subscription instance.

Inheritance
System.Object
Subscription
Namespace: DotNetNuke.Services.Social.Subscriptions.Entities
Assembly: DotNetNuke.dll
Syntax
public class Subscription : object

Properties

| Improve this Doc View Source

CreatedOnDate

Gets or sets the date the user subscribed.

Declaration
public DateTime CreatedOnDate { get; set; }
Property Value
Type Description
DateTime
| Improve this Doc View Source

Description

Gets or sets description of the content which user is subscribed to.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ModuleId

Gets or sets associates the subscription with an instance of a module. If set it uses to apply to Security Trimming. If the user does not have view permission on that module the Subscription won't be retrieved by the SubscriptionController.

Declaration
public int ModuleId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ObjectData

Gets or sets object Data that represents metadata to manage the subscription. The format of the ObjectData is up to the consumer. (i.e.: destinationModule:486, where 486 represents a extra property called Destination Module).

Declaration
public string ObjectData { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ObjectKey

Gets or sets object key that represent the content which user is subscribed to. The format of the ObjectKey is up to the consumer. (i.e.: blog:12, where 12 represents the post identifier).

Declaration
public string ObjectKey { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PortalId

Gets or sets the site the subscription is associated with.

Declaration
public int PortalId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SubscriptionId

Gets or sets the subscription identifier.

Declaration
public int SubscriptionId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SubscriptionTypeId

Gets or sets the type of subscription.

Declaration
public int SubscriptionTypeId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TabId

Gets or sets associates the subscription with a tab. If set it uses to apply to Security Trimming. If the user does not have view permission on that tab the Subscription won't be retrieved by the SubscriptionController.

Declaration
public int TabId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

UserId

Gets or sets the user the subscription is associated with.

Declaration
public int UserId { get; set; }
Property Value
Type Description
System.Int32

Extension Methods