Class MessageSearch

A MessageSearch is a set of parameters for searching an iNaturalist user's private messages. Usage: myINatManager.GetUserMessages(myMessageSearch)

Inheritance
Object
SearchObject
MessageSearch
Inherited Members
Namespace: JoshAaronMiller.INaturalist
Assembly: cs.temp.dll.dll
Syntax
public class MessageSearch : SearchObject

Methods

SetBox(MessageSearch.Box)

Set which box to search, defaults to inbox.

Declaration
public void SetBox(MessageSearch.Box box)
Parameters
Type Name Description
MessageSearch.Box box

The box of messages to search.

SetCorrespondent(String)

Limit the search to only messages with a correspondent of this user ID or username.

Declaration
public void SetCorrespondent(string user)
Parameters
Type Name Description
String user

The user ID or username to limit the search to.

SetPage(Int32)

Set the pagination page number.

Declaration
public void SetPage(int page)
Parameters
Type Name Description
Int32 page

The page of results to fetch.

SetQuery(String)

Set an optional query string to search for in the subject and body of messages.

Declaration
public void SetQuery(string q)
Parameters
Type Name Description
String q

The query string; search will return only messages that match this query in subject or body.

ShowOnlyLatestMessagePerThread(Boolean)

If this setting is toggled on (default off), group the results by thread ID, only show the latest message per thread, and include a thread_messages_count which shows the total number of messages in that thread.

Declaration
public void ShowOnlyLatestMessagePerThread(bool on = false)
Parameters
Type Name Description
Boolean on

Whether to only show the latest message per thread.
Remarks

Note that this setting can only be used if query (q) is not set and thread_messages_count always reports the count from any box instead of the box specified.