Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

GraphRequest interface

Typings for the GraphRequest Object For more information: https://github.com/microsoftgraph/msgraph-sdk-javascript

Property Details

_headers 

_headers: {
 [key: string]: string | number;
 };

Property Value

{ [key: string]: string | number; }

_responseType 

_responseType: string;

Property Value

string

config 

config: Options;

Property Value

@microsoft/microsoft-graph-client!Options:interface

urlComponents 

urlComponents: URLComponents;

Property Value

@microsoft/microsoft-graph-client!URLComponents:interface

Method Details

buildFullUrl() 

buildFullUrl(): string;

Returns

string

constructor(config, path) 

constructor(config: Options, path: string): IGraphRequest;

Parameters

config
@microsoft/microsoft-graph-client!Options:interface
path

string

Returns

count(count) 

count(count: boolean): IGraphRequest;

Parameters

count

boolean

Returns

create(content, callback) 

create(content: any, callback?: GraphRequestCallback): Promise<any>;

Parameters

content

any

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

del(callback) 

del(callback?: GraphRequestCallback): Promise<any>;

Parameters

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

delete(callback) 

delete(callback?: GraphRequestCallback): Promise<any>;

Parameters

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

expand(properties) 

expand(properties: string | string[]): IGraphRequest;

Parameters

properties

string | string[]

Returns

filter(filterStr) 

filter(filterStr: string): IGraphRequest;

Parameters

filterStr

string

Returns

get(callback) 

get(callback?: GraphRequestCallback): Promise<any>;

Parameters

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

getStream(callback) 

getStream(callback: GraphRequestCallback): void;

Parameters

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

void

header(headerKey, headerValue) 

header(headerKey: string, headerValue: string): this;

Parameters

headerKey

string

headerValue

string

Returns

this

headers(headers) 

headers(headers: {
 [key: string]: string | number;
 }): this;

Parameters

headers

{ [key: string]: string | number; }

Returns

this

orderby(properties) 

orderby(properties: string | string[]): IGraphRequest;

Parameters

properties

string | string[]

Returns

parsePath(rawPath) 

parsePath(rawPath: string): void;

Parameters

rawPath

string

Returns

void

patch(content, callback) 

patch(content: any, callback?: GraphRequestCallback): Promise<any>;

Parameters

content

any

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

post(content, callback) 

post(content: any, callback?: GraphRequestCallback): Promise<any>;

Parameters

content

any

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

put(content, callback) 

put(content: any, callback?: GraphRequestCallback): Promise<any>;

Parameters

content

any

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

putStream(stream, callback) 

putStream(stream: any, callback: GraphRequestCallback): void;

Parameters

stream

any

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

void

query(queryDictionaryOrString) 

query(queryDictionaryOrString: string | {
 [key: string]: string | number;
 }): IGraphRequest;

Parameters

queryDictionaryOrString

string | { [key: string]: string | number; }

Returns

responseType(responseType) 

responseType(responseType: string): IGraphRequest;

Parameters

responseType

string

Returns

select(properties) 

select(properties: string | string[]): IGraphRequest;

Parameters

properties

string | string[]

Returns

skip(n) 

skip(n: number): IGraphRequest;

Parameters

n

number

Returns

skipToken(token) 

skipToken(token: string): IGraphRequest;

Parameters

token

string

Returns

top(n) 

top(n: number): IGraphRequest;

Parameters

n

number

Returns

update(content, callback) 

update(content: any, callback?: GraphRequestCallback): Promise<any>;

Parameters

content

any

callback
@microsoft/microsoft-graph-client!GraphRequestCallback:type

Returns

Promise<any>

version(v) 

version(v: string): IGraphRequest;

Parameters

v

string

Returns