RetrievePersonalWallRequest 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 all records that the calling user is following.

For the Web API use the RetrievePersonalWall 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.RetrievePersonalWallRequest

Syntax

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

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

Constructors

	Name	Description
	RetrievePersonalWallRequest()	Initializes a new instance of the RetrievePersonalWallRequest 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.
	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 theExecute method, which returns an instance of the RetrievePersonalWallResponse class.

Privileges and Access Rights

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

Notes for Callers

The posts that are retrieved for your personal wall include the following: the posts that are regarding the records that you follow; the posts that mention records that you follow; and the posts that are regarding you or that mention you. If a post is regarding a record, the Post.RegardingObjectId attribute contains the record ID. If a post mentions a record, the record ID is specified within the Post.Text attribute.

Note

You can only follow records that you have Read permissions for. If you lose Read permissions on a record, a follow is automatically removed.

Note

All Microsoft Dynamics 365 users automatically follow themselves.

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 DisplayPersonalWallPage(int pageNumber)
{
    // Retrieve the page of posts.  We'll only retrieve 5 at a time so that
    // we will have more than one page.
    var pageSize = 5;

    var personalWallPageReq = new RetrievePersonalWallRequest
    {
        CommentsPerPost = 2,
        PageNumber = pageNumber,
        PageSize = pageSize
    };
    var personalWallPageRes =
        (RetrievePersonalWallResponse)_serviceProxy.Execute(personalWallPageReq);

    Console.WriteLine("\r\n  Personal Wall Page {0} Posts:", pageNumber);
    foreach (Post post in personalWallPageRes.EntityCollection.Entities)
    {
        DisplayPost(post);
    }
}



Private Sub DisplayPersonalWallPage(ByVal pageNumber As Integer)
    ' Retrieve the page of posts.  We'll only retrieve 5 at a time so that
    ' we will have more than one page.
    Dim pageSize = 5

    Dim personalWallPageReq = New RetrievePersonalWallRequest With
                              {
                                  .CommentsPerPost = 2,
                                  .PageNumber = pageNumber,
                                  .PageSize = pageSize
                              }
    Dim personalWallPageRes = CType(_serviceProxy.Execute(personalWallPageReq), 
        RetrievePersonalWallResponse)

    Console.WriteLine(vbCrLf &amp; "  Personal Wall Page {0} Posts:", pageNumber)
    For Each post As Post In personalWallPageRes.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.

Share via