Class Relationship

The Relationship class describes the relationships that a user or portal owns. A handful of default Portal-Level Relationships will be be present for every portal (e.g. Friends, Followers, Family). Portal-Level Relationship will have a -1 in UserId field. Any custom User-Level Relationship created by user will also be defined by this class (e.g. My InLaws, Engineering Group). User-Relationship will always have an associcated PortalId. User-Level Relationship will always be tied to a specific Portal.

Inheritance
System.Object
BaseEntityInfo
Relationship
Implements
Inherited Members
Namespace: DotNetNuke.Entities.Users.Social
Assembly: DotNetNuke.dll
Syntax
public class Relationship : BaseEntityInfo, IHydratable

Constructors

| Improve this Doc View Source

Relationship()

Initializes a new instance of the Relationship class.

Declaration
public Relationship()

Properties

| Improve this Doc View Source

DefaultResponse

Gets or sets default Relationship Status to be provided to any new Relationship Request.

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

Description

Gets or sets relationship Description.

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

IsHostList

Gets a value indicating whether is this a Host-Level Relationship (very uncommon).

Declaration
public bool IsHostList { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsPortalList

Gets a value indicating whether is this a Portal-Level Relationship.

Declaration
public bool IsPortalList { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsUserList

Gets a value indicating whether is this a USer-Level Relationship.

Declaration
public bool IsUserList { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

KeyID

Gets or sets iHydratable.KeyID.

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

Name

Gets or sets relationship Name.

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

PortalId

Gets or sets portalId of the User that owns the Relationship. A value of -1 in UserID field indicates that it's a Portal-Level Relationship.

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

RelationshipId

Gets or sets relationshipId - The primary key.

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

RelationshipTypeId

Gets or sets the ID of the Relationship to which this Relation belongs to (e.g. Friend List or Coworkers).

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

UserId

Gets or sets userId of the User that owns the Relationship. A value of -1 indicates that it's a Portal-Level Relationship.

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

Methods

| Improve this Doc View Source

Fill(IDataReader)

Fill the object with data from database.

Declaration
public void Fill(IDataReader dr)
Parameters
Type Name Description
IDataReader dr

the data reader.

Implements

Extension Methods