RetrievePersonalWallRequest Class

 

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 = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrievePersonalWallRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrievePersonalWallRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod RetrievePersonalWallRequest()

Initializes a new instance of the RetrievePersonalWallRequest class.

Properties

Name Description
System_CAPS_pubproperty CommentsPerPost

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

System_CAPS_pubproperty EndDate

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

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty PageNumber

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

System_CAPS_pubproperty PageSize

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

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Source

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

System_CAPS_pubproperty StartDate

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

System_CAPS_pubproperty Type

Reserved for future use.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

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

See Also

RetrievePersonalWallResponse
Microsoft.Crm.Sdk.Messages Namespace
RetrievePersonalWall message privileges
Activity feeds entities
Sample: Collaborate with activity feeds
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright