RetrieveRecordWallRequest RetrieveRecordWallRequest RetrieveRecordWallRequest RetrieveRecordWallRequest Class

Definition

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.

public ref class RetrieveRecordWallRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveRecordWallRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveRecordWallRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveRecordWallRequest
Inherits OrganizationRequest
Inheritance
RetrieveRecordWallRequestRetrieveRecordWallRequestRetrieveRecordWallRequestRetrieveRecordWallRequest
Attributes

Examples


      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)svc.Execute(retrieveRecordWallReq);
       Console.WriteLine("\r\n  Posts for lead {0}:", lead.FullName);
    foreach (Post post in retrieveRecordWallRes.EntityCollection.Entities)
    {
        DisplayPost(post);
    }
}

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(OrganizationRequest) 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.

Constructors

RetrieveRecordWallRequest() RetrieveRecordWallRequest() RetrieveRecordWallRequest() RetrieveRecordWallRequest()

Initializes a new instance of the RetrieveRecordWallRequest class.

Properties

CommentsPerPost CommentsPerPost CommentsPerPost CommentsPerPost

Gets or sets, for retrieval, the number of comments per post. Required.

EndDate EndDate EndDate EndDate

Gets or sets the end date and time of the posts that you want to retrieve. Optional.

Entity Entity Entity Entity

Gets or sets the record for which to retrieve the wall. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
PageNumber PageNumber PageNumber PageNumber

Gets or sets, for retrieval, a specific page of posts that is designated by its page number. Required.

PageSize PageSize PageSize PageSize

Gets or sets, for retrieval, the number of posts per page. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SortDirection SortDirection SortDirection SortDirection
Source Source Source Source

Gets or sets a value that specifies the source of the post. Optional.

StartDate StartDate StartDate StartDate

Gets or sets the start date and time of the posts that you want to retrieve. Optional.

Type Type Type Type

Reserved for future use.

Applies to

See also