Share via


RetrieveRecordWallRequest Class

Definition

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

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
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveRecordWallRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveRecordWallRequest
Inherits OrganizationRequest
Inheritance
RetrieveRecordWallRequest
Attributes

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 instance. For the complete sample, see the link later in this topic.

Remarks

For the Web API use the RetrieveRecordWall function.

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

Initializes a new instance of the RetrieveRecordWallRequest class.

Properties

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)
Keyword
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 the request. Optional.

(Inherited from OrganizationRequest)
RequestName

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

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

Applies to

See also