RetrieveRecordWallRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to retrieve pages of posts, including comments for each post, for a specified record.

For the Web API use the RetrieveRecordWall Function.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveRecordWallRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveRecordWallRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveRecordWallRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	RetrieveRecordWallRequest()	Initializes a new instance of the RetrieveRecordWallRequest class.

Properties

	Name	Description
	CommentsPerPost	Gets or sets, for retrieval, the number of comments per post. Required.
	EndDate	Gets or sets the end date and time of the posts that you want to retrieve. Optional.
	Entity	Gets or sets the record for which to retrieve the wall. Required.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	PageNumber	Gets or sets, for retrieval, a specific page of posts that is designated by its page number. Required.
	PageSize	Gets or sets, for retrieval, the number of posts per page. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Source	Gets or sets a value that specifies the source of the post. Optional.
	StartDate	Gets or sets the start date and time of the posts that you want to retrieve. Optional.
	Type	Reserved for future use.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveRecordWallResponse class.

Privileges and Access Rights

To perform this action, the caller must have the privileges on the specified entity in the Entity property and the access rights on the records that the returned posts regard or mention.

For a complete list of the required privileges, see RetrieveRecordWall message privileges.

Notes for Callers

The posts that are retrieved for a record wall include the posts that are regarding the record or that mention the record. For a system user (user) record wall, retrieved posts also include the posts that the user created. If a post is regarding a record, the Post.RegardingObjectId attribute contains the record ID. If a record is the system user (user) record, the Post.RegardingObjectId attribute contains the current user ID. If a post mentions a record, the record ID is specified within the Post.Text attribute.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


private void DisplayRecordWall(Lead lead)
{
    // Display the first page of the record wall.
    var retrieveRecordWallReq = new RetrieveRecordWallRequest
    {
        Entity = lead.ToEntityReference(),
        CommentsPerPost = 2,
        PageSize = 10,
        PageNumber = 1
    };

    var retrieveRecordWallRes =
        (RetrieveRecordWallResponse)_serviceProxy.Execute(retrieveRecordWallReq);

    Console.WriteLine("\r\n  Posts for lead {0}:", lead.FullName);
    foreach (Post post in retrieveRecordWallRes.EntityCollection.Entities)
    {
        DisplayPost(post);
    }
}


Private Sub DisplayRecordWall(ByVal lead As Lead)
    ' Display the first page of the record wall.
    Dim retrieveRecordWallReq = New RetrieveRecordWallRequest With
                                {
                                    .Entity = lead.ToEntityReference(),
                                    .CommentsPerPost = 2,
                                    .PageSize = 10,
                                    .PageNumber = 1
                                }

    Dim retrieveRecordWallRes = CType(_serviceProxy.Execute(retrieveRecordWallReq), 
        RetrieveRecordWallResponse)

    Console.WriteLine(vbCrLf &amp; "  Posts for lead {0}:", lead.FullName)
    For Each post As Post In retrieveRecordWallRes.EntityCollection.Entities
        DisplayPost(post)
    Next post
End Sub

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.