Stack.PHP
A simple and easy to use PHP library for the Stack Exchange API.
Public Member Functions | List of all members
InboxItemRequest Class Reference

A request for items in a user's inbox. More...

Inheritance diagram for InboxItemRequest:
PagedRequest

Public Member Functions

 __construct ($url, $access_token=null)
 Constructor for an inbox item request. More...
 
 Unread ()
 Retrieves only unread items from the users inbox. More...
 
 Since ($date)
 Causes only inbox items that were added later than the specified time to be returned. More...
 
- Public Member Functions inherited from PagedRequest
 __construct ($url, $return_object, $category=null, $method=null)
 Constructor for a paged request. More...
 
 Exec ()
 Performs the HTTP request. More...
 
 ID ($id)
 Adds the provided ID(s) to the request. More...
 
 Tag ($tag)
 Adds the provided tags to the request. More...
 
 FromDate ($date)
 Ensures that only items created after the specified date are returned in the response. More...
 
 ToDate ($date)
 Ensures that only items created before the specified date are returned in the response. More...
 
 Min ($minimum)
 Sets the minimum value for the range of the current sort. More...
 
 Max ($maximum)
 Sets the maximum value for the range of the current sort. More...
 
 Filter ($filter, $pagination_filter=null)
 Sets the specified filter for the request. More...
 
 URL ()
 Returns the URL constructed from this request. More...
 
 Ascending ()
 Causes the items to be returned in ascending order. More...
 
 Descending ()
 Causes the items to be returned in descending order. More...
 
 InName ($name)
 Returns only the items that contain the specified text in their names. More...
 
 SortBy ($method)
 Sort the results by the provided sort method. More...
 
 SortByActivity ()
 Orders the returned items by activity. More...
 
 SortByCreation ()
 Orders the returned items by creation date. More...
 
 SortByName ()
 Orders the returned items by their name. More...
 
 SortByVotes ()
 Orders the returned items by their score. More...
 

Additional Inherited Members

- Protected Attributes inherited from PagedRequest
 $url
 The URL that will be modified as methods are called.
 

Detailed Description

A request for items in a user's inbox.

Constructor & Destructor Documentation

◆ __construct()

InboxItemRequest::__construct (   $url,
  $access_token = null 
)

Constructor for an inbox item request.

Parameters
$urlthe domain name of the site or a URL object
$access_tokena valid access token

Member Function Documentation

◆ Since()

InboxItemRequest::Since (   $date)

Causes only inbox items that were added later than the specified time to be returned.

Parameters
$datea timestamp that represents the minimum time that returned items should have
Returns
the current instance

◆ Unread()

InboxItemRequest::Unread ( )

Retrieves only unread items from the users inbox.

Returns
the current instance

The documentation for this class was generated from the following file: