RetrieveRecordWallRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

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

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

Syntax

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

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

Example

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 & "  Posts for lead {0}:", lead.FullName)
    For Each post As Post In retrieveRecordWallRes.EntityCollection.Entities
        DisplayPost(post)
    Next post
End Sub

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 RetrieveRecordWallRequest 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.

Inheritance Hierarchy

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

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

RetrieveRecordWallRequest Class

Syntax

Example

Remarks

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources