IRest
@nuclia/core • Docs
@nuclia/core / IRest
Interface: IRest
Methods
checkAuthorization()
checkAuthorization(
path):Observable<object>
Parameters
• path: string
Returns
Observable<object>
allowed
allowed:
boolean
roles
roles: (
NucliaDBRole|KBRoles)[]
Defined in
libs/sdk-core/src/lib/models.ts:120
delete()
delete(
path,extraHeaders?,synchronous?,zoneSlug?):Observable<void>
Parameters
• path: string
• extraHeaders?
• synchronous?: boolean
• zoneSlug?: string
Returns
Observable<void>
Defined in
libs/sdk-core/src/lib/models.ts:101
get()
get<
T>(path,extraHeaders?,doNotParse?,zoneSlug?):Observable<T>
Type Parameters
• T
Parameters
• path: string
• extraHeaders?
• doNotParse?: boolean
• zoneSlug?: string
Returns
Observable<T>
Defined in
libs/sdk-core/src/lib/models.ts:68
getFullUrl()
getFullUrl(
path):string
Parameters
• path: string
Returns
string
Defined in
libs/sdk-core/src/lib/models.ts:110
getHeaders()
getHeaders(
method,path,extraHeaders?,synchronous?):object
Parameters
• method: string
• path: string
• extraHeaders?
• synchronous?: boolean
Returns
object
Defined in
libs/sdk-core/src/lib/models.ts:122
getObjectURL()
getObjectURL(
path):Observable<string>
Parameters
• path: string
Returns
Observable<string>
Defined in
libs/sdk-core/src/lib/models.ts:111
getStreamedResponse()
getStreamedResponse(
path,body,extraHeaders?):Observable<object>
Parameters
• path: string
• body: any
• extraHeaders?
Returns
Observable<object>
data
data:
Uint8Array<ArrayBufferLike>
headers
headers:
Headers
incomplete
incomplete:
boolean
Defined in
libs/sdk-core/src/lib/models.ts:112
getStreamMessages()
getStreamMessages(
path,controller):Observable<object>
Parameters
• path: string
• controller: AbortController
Returns
Observable<object>
data
data:
Uint8Array<ArrayBufferLike>
headers
headers:
Headers
Defined in
libs/sdk-core/src/lib/models.ts:119
getWsUrl()
getWsUrl(
path,ephemeralToken):string
Parameters
• path: string
• ephemeralToken: string
Returns
string
Defined in
libs/sdk-core/src/lib/models.ts:131
getZones()
getZones():
Observable<object>
Returns
Observable<object>
Defined in
libs/sdk-core/src/lib/models.ts:108
getZoneSlug()
getZoneSlug(
zoneId):Observable<string>
Parameters
• zoneId: string
Returns
Observable<string>
Defined in
libs/sdk-core/src/lib/models.ts:109
head()
head(
path,extraHeaders?):Observable<Response>
Parameters
• path: string
• extraHeaders?
Returns
Observable<Response>
Defined in
libs/sdk-core/src/lib/models.ts:107
patch()
patch<
T>(path,body,extraHeaders?,doNotParse?,synchronous?,zoneSlug?):Observable<T>
Type Parameters
• T
Parameters
• path: string
• body: any
• extraHeaders?
• doNotParse?: boolean
• synchronous?: boolean
• zoneSlug?: string
Returns
Observable<T>
Defined in
libs/sdk-core/src/lib/models.ts:92
post()
post<
T>(path,body,extraHeaders?,doNotParse?,synchronous?,zoneSlug?):Observable<T>
Type Parameters
• T
Parameters
• path: string
• body: any
• extraHeaders?
• doNotParse?: boolean
• synchronous?: boolean
• zoneSlug?: string
Returns
Observable<T>
Defined in
libs/sdk-core/src/lib/models.ts:74
put()
put<
T>(path,body,extraHeaders?,doNotParse?,synchronous?,zoneSlug?):Observable<T>
Type Parameters
• T
Parameters
• path: string
• body: any
• extraHeaders?
• doNotParse?: boolean
• synchronous?: boolean
• zoneSlug?: string
Returns
Observable<T>