IRest
@nuclia/core / IRest
Interface: IRest
Defined in: libs/sdk-core/src/lib/models.ts:81
Methods
checkAuthorization()
checkAuthorization(
path):Observable<{allowed:boolean;roles: (NucliaDBRole|KBRoles)[]; }>
Defined in: libs/sdk-core/src/lib/models.ts:137
Parameters
path
string
Returns
Observable<{ allowed: boolean; roles: (NucliaDBRole | KBRoles)[]; }>
delete()
delete(
path,extraHeaders?,synchronous?,zoneSlug?):Observable<void>
Defined in: libs/sdk-core/src/lib/models.ts:115
Parameters
path
string
extraHeaders?
synchronous?
boolean
zoneSlug?
string
Returns
Observable<void>
get()
get<
T>(path,extraHeaders?,doNotParse?,zoneSlug?):Observable<T>
Defined in: libs/sdk-core/src/lib/models.ts:82
Type Parameters
T
T
Parameters
path
string
extraHeaders?
doNotParse?
boolean
zoneSlug?
string
Returns
Observable<T>
getAccountZones()
getAccountZones(
accountIdOrSlug):Observable<{[key:string]:string; }>
Defined in: libs/sdk-core/src/lib/models.ts:124
Parameters
accountIdOrSlug
string
Returns
Observable<{[key: string]: string; }>
getFullUrl()
getFullUrl(
path):string
Defined in: libs/sdk-core/src/lib/models.ts:127
Parameters
path
string
Returns
string
getHeaders()
getHeaders(
method,path,extraHeaders?,synchronous?,formData?):object
Defined in: libs/sdk-core/src/lib/models.ts:139
Parameters
method
string
path
string
extraHeaders?
synchronous?
boolean
formData?
boolean
Returns
object
getObjectURL()
getObjectURL(
path):Observable<string>
Defined in: libs/sdk-core/src/lib/models.ts:128
Parameters
path
string
Returns
Observable<string>
getStreamedResponse()
getStreamedResponse(
path,body,extraHeaders?):Observable<{data:Uint8Array;headers:Headers;incomplete:boolean; }>
Defined in: libs/sdk-core/src/lib/models.ts:129
Parameters
path
string
body
any
extraHeaders?
Returns
Observable<{ data: Uint8Array; headers: Headers; incomplete: boolean; }>
getStreamMessages()
getStreamMessages(
path,controller):Observable<{data:Uint8Array;headers:Headers; }>
Defined in: libs/sdk-core/src/lib/models.ts:136
Parameters
path
string
controller
AbortController
Returns
Observable<{ data: Uint8Array; headers: Headers; }>
getWsUrl()
getWsUrl(
path,ephemeralToken):string
Defined in: libs/sdk-core/src/lib/models.ts:149
Parameters
path
string
ephemeralToken
string
Returns
string
getZoneOrigin()
getZoneOrigin(
slug):string|null|undefined
Defined in: libs/sdk-core/src/lib/models.ts:125
Parameters
slug
string
Returns
string | null | undefined
getZones()
getZones():
Observable<{[key:string]:string; }>
Defined in: libs/sdk-core/src/lib/models.ts:122
Returns
Observable<{[key: string]: string; }>
getZoneSlug()
getZoneSlug(
zoneId):Observable<string>
Defined in: libs/sdk-core/src/lib/models.ts:123
Parameters
zoneId
string
Returns
Observable<string>
head()
head(
path,extraHeaders?):Observable<Response>
Defined in: libs/sdk-core/src/lib/models.ts:121
Parameters
path
string
extraHeaders?
Returns
Observable<Response>
patch()
patch<
T>(path,body,extraHeaders?,doNotParse?,synchronous?,zoneSlug?):Observable<T>
Defined in: libs/sdk-core/src/lib/models.ts:106
Type Parameters
T
T
Parameters
path
string
body
any
extraHeaders?
doNotParse?
boolean
synchronous?
boolean
zoneSlug?
string
Returns
Observable<T>
post()
post<
T>(path,body,extraHeaders?,doNotParse?,synchronous?,zoneSlug?):Observable<T>
Defined in: libs/sdk-core/src/lib/models.ts:88
Type Parameters
T
T
Parameters
path
string
body
any
extraHeaders?
doNotParse?
boolean
synchronous?
boolean
zoneSlug?
string
Returns
Observable<T>
put()
put<
T>(path,body,extraHeaders?,doNotParse?,synchronous?,zoneSlug?):Observable<T>
Defined in: libs/sdk-core/src/lib/models.ts:97
Type Parameters
T
T
Parameters
path
string
body
any
extraHeaders?
doNotParse?
boolean
synchronous?
boolean
zoneSlug?
string
Returns
Observable<T>
setZoneOrigins()
setZoneOrigins(
origins):void
Defined in: libs/sdk-core/src/lib/models.ts:126
Parameters
origins
Returns
void