com.microsoft.graph.requests.extensions

Class ListRequest

java.lang.Object

com.microsoft.graph.http.BaseRequest

com.microsoft.graph.requests.extensions.ListRequest

All Implemented Interfaces:

IHttpRequest, IListRequest

public class ListRequest
extends BaseRequest
implements IListRequest

The class for the List Request.

Field Summary

Fields inherited from class com.microsoft.graph.http.BaseRequest

functionOptions, queryOptions, REQUEST_STATS_HEADER_VALUE_FORMAT_STRING

Constructor Summary

Constructors

Constructor and Description
ListRequest(java.lang.String requestUrl, IBaseClient client, java.util.List<? extends Option> requestOptions) The request for the List

Method Summary

Modifier and Type	Method and Description
void	delete() Delete this item from the service
void	delete(ICallback<List> callback) Delete this item from the service
IListRequest	expand(java.lang.String value) Sets the expand clause for the request
List	get() Gets the List from the service
void	get(ICallback<List> callback) Gets the List from the service
List	patch(List sourceList) Patches this List with a source
void	patch(List sourceList, ICallback<List> callback) Patches this List with a source
List	post(List newList) Creates a List with a new object
void	post(List newList, ICallback<List> callback) Creates a List with a new object
IListRequest	select(java.lang.String value) Sets the select clause for the request

Methods inherited from class com.microsoft.graph.http.BaseRequest

addFunctionOption, addHeader, addQueryOption, getClient, getDelay, getFunctionOptions, getHeaders, getHttpMethod, getMaxRedirects, getMaxRetries, getOptions, getQueryOptions, getRequestUrl, getResponseType, getShouldRedirect, getShouldRetry, getUseCaches, send, send, setDelay, setHttpMethod, setMaxRedirects, setMaxRetries, setShouldRedirect, setShouldRetry, setUseCaches

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microsoft.graph.http.IHttpRequest

addHeader, getDelay, getHeaders, getHttpMethod, getMaxRedirects, getMaxRetries, getOptions, getRequestUrl, getShouldRedirect, getShouldRetry, getUseCaches, setDelay, setMaxRedirects, setMaxRetries, setShouldRedirect, setShouldRetry, setUseCaches

Constructor Detail

ListRequest

public ListRequest(java.lang.String requestUrl,
                   IBaseClient client,
                   java.util.List<? extends Option> requestOptions)

The request for the List

Parameters:

requestUrl - the request URL

client - the service client

requestOptions - the options for this request

Method Detail

get

public void get(ICallback<List> callback)

Gets the List from the service

Specified by:

get in interface IListRequest

Parameters:

callback - the callback to be called after success or failure

get

public List get()
         throws ClientException

Gets the List from the service

Specified by:

get in interface IListRequest

Returns:

the List from the request

Throws:

ClientException - this exception occurs if the request was unable to complete for any reason

delete

public void delete(ICallback<List> callback)

Delete this item from the service

Specified by:

delete in interface IListRequest

Parameters:

callback - the callback when the deletion action has completed

delete

public void delete()
            throws ClientException

Delete this item from the service

Specified by:

delete in interface IListRequest

Throws:

ClientException - if there was an exception during the delete operation

patch

public void patch(List sourceList,
                  ICallback<List> callback)

Patches this List with a source

Specified by:

patch in interface IListRequest

Parameters:

sourceList - the source object with updates

callback - the callback to be called after success or failure

patch

public List patch(List sourceList)
           throws ClientException

Patches this List with a source

Specified by:

patch in interface IListRequest

Parameters:

sourceList - the source object with updates

Returns:

the updated List

Throws:

ClientException - this exception occurs if the request was unable to complete for any reason

post

public void post(List newList,
                 ICallback<List> callback)

Creates a List with a new object

Specified by:

post in interface IListRequest

Parameters:

newList - the new object to create

callback - the callback to be called after success or failure

post

public List post(List newList)
          throws ClientException

Creates a List with a new object

Specified by:

post in interface IListRequest

Parameters:

newList - the new object to create

Returns:

the created List

Throws:

ClientException - this exception occurs if the request was unable to complete for any reason

select

public IListRequest select(java.lang.String value)

Sets the select clause for the request

Specified by:

select in interface IListRequest

Parameters:

value - the select clause

Returns:

the updated request

expand

public IListRequest expand(java.lang.String value)

Sets the expand clause for the request

Specified by:

expand in interface IListRequest

Parameters:

value - the expand clause

Returns:

the updated request