Skip to main content

useCache

Datalayer Core

Datalayer Core / useCache

Function: useCache()

useCache(__namedParameters): object

Defined in: tech/datalayer/core/src/hooks/useCache.tsx:136

Callbacks to RUN service.

It assumes to be used within a Router component. If not you must set the options loginRoute to null (raise an error Unauthorized instead of redirecting to the login page).

Parameters​

__namedParameters​

CacheProps = {}

Returns​

addMemberToOrganization()​

addMemberToOrganization: (organizationId, userId) => Promise<any>

Parameters​

organizationId​

string

userId​

string

Returns​

Promise<any>

addMemberToOrganizationSpace()​

addMemberToOrganizationSpace: (organizationId, spaceId, accountId) => Promise<any>

Parameters​

organizationId​

string

spaceId​

string

accountId​

string

Returns​

Promise<any>

addMemberToTeam()​

addMemberToTeam: (teamId, userId) => Promise<any>

Parameters​

teamId​

string

userId​

string

Returns​

Promise<any>

addRoleToOrganizationMember()​

addRoleToOrganizationMember: (organizationId, userId, roleName) => Promise<any>

Parameters​

organizationId​

string

userId​

string

roleName​

string

Returns​

Promise<any>

addRoleToTeamMember()​

addRoleToTeamMember: (teamId, userId, roleName) => Promise<any>

Parameters​

teamId​

string

userId​

string

roleName​

string

Returns​

Promise<any>

assignRoleToUser()​

assignRoleToUser: (userId, roleName) => Promise<any>

Parameters​

userId​

any

roleName​

any

Returns​

Promise<any>

assignTagToContact()​

assignTagToContact: (contactId, tagName) => Promise<any>

Parameters​

contactId​

any

tagName​

any

Returns​

Promise<any>

burnCredit()​

burnCredit: (credits) => Promise<any>

Parameters​

credits​

any

Returns​

Promise<any>

changePassword()​

changePassword: (handle, password, passwordConfirm) => Promise<any>

Parameters​

handle​

any

password​

any

passwordConfirm​

any

Returns​

Promise<any>

clearAllCaches()​

clearAllCaches: () => void

Returns​

void

clearCachedDatasources()​

clearCachedDatasources: () => void

Returns​

void

clearCachedInvites()​

clearCachedInvites: () => void

Returns​

void

clearCachedItems()​

clearCachedItems: () => void

Returns​

void

clearCachedOrganizations()​

clearCachedOrganizations: () => void

Returns​

void

clearCachedPages()​

clearCachedPages: () => void

Returns​

void

clearCachedPublicItems()​

clearCachedPublicItems: () => void

Returns​

void

clearCachedSecrets()​

clearCachedSecrets: () => void

Returns​

void

clearCachedTeams()​

clearCachedTeams: () => void

Returns​

void

clearCachedTokens()​

clearCachedTokens: () => void

Returns​

void

cloneAssignment()​

cloneAssignment: (assignmentId) => Promise<any>

Parameters​

assignmentId​

string

Returns​

Promise<any>

cloneCell()​

cloneCell: (cellId) => Promise<any>

Parameters​

cellId​

string

Returns​

Promise<any>

cloneDocument()​

cloneDocument: (documentId) => Promise<any>

Parameters​

documentId​

string

Returns​

Promise<any>

cloneExercise()​

cloneExercise: (exerciseId) => Promise<any>

Parameters​

exerciseId​

string

Returns​

Promise<any>

cloneLesson()​

cloneLesson: (lessonId) => Promise<any>

Parameters​

lessonId​

string

Returns​

Promise<any>

cloneNotebook()​

cloneNotebook: (notebookId) => Promise<any>

Parameters​

notebookId​

string

Returns​

Promise<any>

confirmCourseItemCompletion()​

confirmCourseItemCompletion: (courseId, itemType, itemId, completed) => Promise<any>

Parameters​

courseId​

any

itemType​

IItemType

itemId​

string

completed​

boolean

Returns​

Promise<any>

confirmEmailUpdate()​

confirmEmailUpdate: (token) => Promise<any>

Parameters​

token​

any

Returns​

Promise<any>

confirmJoinWithToken()​

confirmJoinWithToken: (userHandle, token) => Promise<any>

Parameters​

userHandle​

any

token​

any

Returns​

Promise<any>

confirmPassworkWithToken()​

confirmPassworkWithToken: (userHandle, token) => Promise<any>

Parameters​

userHandle​

any

token​

any

Returns​

Promise<any>

createCheckoutSession()​

createCheckoutSession: (product, location) => Promise<any>

Parameters​

product​

any

location​

any

Returns​

Promise<any>

createContact()​

createContact: (contact) => Promise<any>

Parameters​

contact​

IContact

Returns​

Promise<any>

createDatasource()​

createDatasource: (datasource) => Promise<any>

Parameters​

datasource​

Omit<IDatasource, "id">

Returns​

Promise<any>

createOrganization()​

createOrganization: (organization) => Promise<any>

Parameters​

organization​

Partial<IOrganization>

Returns​

Promise<any>

createPage()​

createPage: (page) => Promise<any>

Parameters​

page​

Omit<IPage, "id">

Returns​

Promise<any>

createSecret()​

createSecret: (secret) => Promise<any>

Parameters​

secret​

Omit<ISecret, "id">

Returns​

Promise<any>

createSpace()​

createSpace: (space, organization?) => Promise<any>

Parameters​

space​

Partial<IAnySpace>

organization?​

IAnyOrganization

Returns​

Promise<any>

createTeam()​

createTeam: (team, organization) => Promise<any>

Parameters​

team​

Partial<ITeam>

organization​

IAnyOrganization

Returns​

Promise<any>

createToken()​

createToken: (token) => Promise<any>

Parameters​

token​

Omit<IIAMToken, "id" | "value">

Returns​

Promise<any>

createTokenForPasswordChange()​

createTokenForPasswordChange: (handle, password, passwordConfirm) => Promise<any>

Parameters​

handle​

any

password​

any

passwordConfirm​

any

Returns​

Promise<any>

deleteContact()​

deleteContact: (contactId) => Promise<any>

Parameters​

contactId​

string

Returns​

Promise<any>

deleteItem()​

deleteItem: (itemId) => Promise<any>

Parameters​

itemId​

string

Returns​

Promise<any>

deleteOutbound()​

deleteOutbound: (outboundId) => Promise<any>

Parameters​

outboundId​

string

Returns​

Promise<any>

deletePage()​

deletePage: (page) => Promise<any>

Parameters​

page​

IPage

Returns​

Promise<any>

deleteSecret()​

deleteSecret: (secret) => Promise<any>

Parameters​

secret​

ISecret

Returns​

Promise<any>

disableUserMFA()​

disableUserMFA: () => Promise<any>

Returns​

Promise<any>

draftBulkEmailsOutbounds()​

draftBulkEmailsOutbounds: (params) => Promise<any>

Parameters​

params​

any

Returns​

Promise<any>

enableUserMFA()​

enableUserMFA: () => Promise<any>

Returns​

Promise<any>

enrichContactEmail()​

enrichContactEmail: (contactId, useDomain) => Promise<any>

Parameters​

contactId​

any

useDomain​

any

Returns​

Promise<any>

enrichContactLinkedin()​

enrichContactLinkedin: (contactId) => Promise<any>

Parameters​

contactId​

any

Returns​

Promise<any>

enrollStudentToCourse()​

enrollStudentToCourse: (courseId, studentId) => Promise<any>

Parameters​

courseId​

string

studentId​

string

Returns​

Promise<any>

exportSpace()​

exportSpace: (spaceId) => Promise<any>

Parameters​

spaceId​

string

Returns​

Promise<any>

getAssignment()​

getAssignment: (assignmentId) => undefined | IAssignment

Parameters​

assignmentId​

any

Returns​

undefined | IAssignment

getAssignmentForStudent()​

getAssignmentForStudent: (assignmentId) => undefined | IAssignment

Parameters​

assignmentId​

string

Returns​

undefined | IAssignment

getAssignmentStudentVersion()​

getAssignmentStudentVersion: (assignmentId) => Promise<any>

Parameters​

assignmentId​

any

Returns​

Promise<any>

getCell()​

getCell: (id) => undefined | ICell

Parameters​

id​

string

Returns​

undefined | ICell

getContactByHandle()​

getContactByHandle: (contactHandle) => undefined | IContact

Parameters​

contactHandle​

string

Returns​

undefined | IContact

getContactById()​

getContactById: (contactId) => undefined | IContact

Parameters​

contactId​

string

Returns​

undefined | IContact

getCourse()​

getCourse: (courseId) => undefined | ICourse

Parameters​

courseId​

string

Returns​

undefined | ICourse

getCoursesEnrollments()​

getCoursesEnrollments: () => ICourse[]

Returns​

ICourse[]

getDataset()​

getDataset: (id) => undefined | IDataset

Parameters​

id​

any

Returns​

undefined | IDataset

getDatasource()​

getDatasource: (datasourceId) => undefined | IDatasource

Parameters​

datasourceId​

string

Returns​

undefined | IDatasource

getDatasources()​

getDatasources: () => IDatasource[]

Returns​

IDatasource[]

getDocument()​

getDocument: (id) => undefined | IDocument

Parameters​

id​

any

Returns​

undefined | IDocument

getEnvironment()​

getEnvironment: (id) => undefined | IEnvironment

Parameters​

id​

string

Returns​

undefined | IEnvironment

getExercise()​

getExercise: (id) => undefined | IExercise

Parameters​

id​

string

Returns​

undefined | IExercise

getGitHubProfile()​

getGitHubProfile: (accessToken) => Promise<any>

Parameters​

accessToken​

string

Returns​

Promise<any>

getGrowthKPI()​

getGrowthKPI: () => Promise<any>

Returns​

Promise<any>

getInbound()​

getInbound: (id) => undefined | IInbound

Parameters​

id​

string

Returns​

undefined | IInbound

getInboundByHandle()​

getInboundByHandle: (handle) => undefined | IInbound

Parameters​

handle​

string

Returns​

undefined | IInbound

getInbounds()​

getInbounds: () => Promise<any>

Returns​

Promise<any>

getInstructorCourses()​

getInstructorCourses: () => ICourse[]

Returns​

ICourse[]

getInvite()​

getInvite: (token) => undefined | IInvite

Parameters​

token​

string

Returns​

undefined | IInvite

getInvites()​

getInvites: () => IInvite[]

Returns​

IInvite[]

getLesson()​

getLesson: (id) => undefined | ILesson

Parameters​

id​

any

Returns​

undefined | ILesson

getLinkedinProfile()​

getLinkedinProfile: (accessToken) => Promise<LinkedInUser>

Parameters​

accessToken​

string

Returns​

Promise<LinkedInUser>

getMe()​

getMe: (token?) => Promise<null | IUser>

Parameters​

token?​

string

Returns​

Promise<null | IUser>

getNotebook()​

getNotebook: (notebookId) => undefined | INotebook

Parameters​

notebookId​

any

Returns​

undefined | INotebook

getOAuth2AuthorizationLinkURL()​

getOAuth2AuthorizationLinkURL: (queryArgs) => Promise<{ autorization_url: string; success: boolean; }>

Parameters​

queryArgs​

Record<string, string>

Returns​

Promise<{ autorization_url: string; success: boolean; }>

getOAuth2AuthorizationURL()​

getOAuth2AuthorizationURL: (queryArgs) => Promise<{ autorization_url: string; success: boolean; }>

Parameters​

queryArgs​

Record<string, string>

Returns​

Promise<{ autorization_url: string; success: boolean; }>

getOrganizationByHandle()​

getOrganizationByHandle: (organizationHandle) => undefined | IOrganization

Parameters​

organizationHandle​

string

Returns​

undefined | IOrganization

getOrganizationById()​

getOrganizationById: (organizationId) => undefined | IOrganization

Parameters​

organizationId​

string

Returns​

undefined | IOrganization

getOrganizationSpace()​

getOrganizationSpace: (organizationId, spaceId) => undefined | IAnySpace

Parameters​

organizationId​

string

spaceId​

string

Returns​

undefined | IAnySpace

getOrganizationSpaceByHandle()​

getOrganizationSpaceByHandle: (organizationHandle, spaceHandle) => undefined | IAnySpace

Parameters​

organizationHandle​

string

spaceHandle​

string

Returns​

undefined | IAnySpace

getOrganizationSpaces()​

getOrganizationSpaces: (organizationId) => IAnySpace[]

Parameters​

organizationId​

string

Returns​

IAnySpace[]

getOutbound()​

getOutbound: (id) => undefined | IOutbound

Parameters​

id​

string

Returns​

undefined | IOutbound

getOutbounds()​

getOutbounds: () => Promise<any>

Returns​

Promise<any>

getPage()​

getPage: (pageId) => undefined | IPage

Parameters​

pageId​

string

Returns​

undefined | IPage

getPages()​

getPages: () => IPage[]

Returns​

IPage[]

getPlatformUsages()​

getPlatformUsages: () => Promise<{ message: string; success: boolean; usages?: IUsage[]; }>

Get platform usages

Returns​

Promise<{ message: string; success: boolean; usages?: IUsage[]; }>

getPublicCourses()​

getPublicCourses: () => ICourse[]

Returns​

ICourse[]

getPublicItems()​

getPublicItems: () => ISpaceItem[]

Returns​

ISpaceItem[]

getSchools()​

getSchools: () => ISchool[]

Returns​

ISchool[]

getSecret()​

getSecret: (secretId) => undefined | ISecret

Parameters​

secretId​

string

Returns​

undefined | ISecret

getSecrets()​

getSecrets: () => ISecret[]

Returns​

ISecret[]

getSpaceAssignment()​

getSpaceAssignment: (id) => undefined | IAssignment

Parameters​

id​

any

Returns​

undefined | IAssignment

getSpaceAssignments()​

getSpaceAssignments: () => IAssignment[]

Returns​

IAssignment[]

getSpaceCells()​

getSpaceCells: () => ICell[]

Returns​

ICell[]

getSpaceDatasets()​

getSpaceDatasets: () => IDataset[]

Returns​

IDataset[]

getSpaceDocument()​

getSpaceDocument: (id) => undefined | IDocument

Parameters​

id​

any

Returns​

undefined | IDocument

getSpaceDocuments()​

getSpaceDocuments: () => IDocument[]

Returns​

IDocument[]

getSpaceEnvironments()​

getSpaceEnvironments: () => IEnvironment[]

Returns​

IEnvironment[]

getSpaceExercises()​

getSpaceExercises: () => IExercise[]

Returns​

IExercise[]

getSpaceItems()​

getSpaceItems: () => ISpaceItem[]

Returns​

ISpaceItem[]

getSpaceLesson()​

getSpaceLesson: (id) => undefined | ILesson

Parameters​

id​

any

Returns​

undefined | ILesson

getSpaceLessons()​

getSpaceLessons: () => ILesson[]

Returns​

ILesson[]

getSpaceNotebook()​

getSpaceNotebook: (id) => undefined | INotebook

Parameters​

id​

any

Returns​

undefined | INotebook

getSpaceNotebooks()​

getSpaceNotebooks: () => INotebook[]

Returns​

INotebook[]

getStudent()​

getStudent: (courseId, studentId) => undefined | IStudent

Parameters​

courseId​

any

studentId​

any

Returns​

undefined | IStudent

getTeamByHandle()​

getTeamByHandle: (teamHandle) => undefined | ITeam

Parameters​

teamHandle​

string

Returns​

undefined | ITeam

getTeamById()​

getTeamById: (teamId) => undefined | ITeam

Parameters​

teamId​

string

Returns​

undefined | ITeam

getTeamsByOrganizationId()​

getTeamsByOrganizationId: (organizationId) => undefined | ITeam[]

Parameters​

organizationId​

string

Returns​

undefined | ITeam[]

getToken()​

getToken: (tokenId) => undefined | IIAMToken

Parameters​

tokenId​

string

Returns​

undefined | IIAMToken

getTokens()​

getTokens: () => IIAMToken[]

Returns​

IIAMToken[]

getUsages()​

getUsages: () => Promise<{ message: string; success: boolean; usages?: IUsage[]; }>

Get user usages

Returns​

Promise<{ message: string; success: boolean; usages?: IUsage[]; }>

getUsagesForUser()​

getUsagesForUser: (userId) => Promise<{ message: string; success: boolean; usages?: IUsage[]; }>

Get user usages

Parameters​

userId​

string

Returns​

Promise<{ message: string; success: boolean; usages?: IUsage[]; }>

getUser()​

getUser: (id) => undefined | IUser

Parameters​

id​

string

Returns​

undefined | IUser

getUserByHandle()​

getUserByHandle: (handle) => undefined | IUser

Parameters​

handle​

string

Returns​

undefined | IUser

getUserCredits()​

getUserCredits: (userId) => Promise<any>

Parameters​

userId​

any

Returns​

Promise<any>

getUserOrganizationById()​

getUserOrganizationById: (organizationId) => undefined | IAnyOrganization

Parameters​

organizationId​

string

Returns​

undefined | IAnyOrganization

getUserOrganizations()​

getUserOrganizations: () => IAnyOrganization[]

Returns​

IAnyOrganization[]

getUserSpace()​

getUserSpace: (userId) => undefined | IAnySpace

Parameters​

userId​

string

Returns​

undefined | IAnySpace

getUserSpaceByHandle()​

getUserSpaceByHandle: (userHandle) => undefined | IAnySpace

Parameters​

userHandle​

string

Returns​

undefined | IAnySpace

getUserSpaces()​

getUserSpaces: () => IAnySpace[]

Returns​

IAnySpace[]

getUserSurveys()​

getUserSurveys: (userId) => Promise<any>

Parameters​

userId​

string

Returns​

Promise<any>

gradeAssignmentForStudent()​

gradeAssignmentForStudent: (courseId, user, assignmentId, model) => Promise<any>

Parameters​

courseId​

string

user​

IUser

assignmentId​

string

model​

any

Returns​

Promise<any>

joinWithInvite()​

joinWithInvite: (formValues, token) => Promise<any>

Parameters​

formValues​

any

token​

any

Returns​

Promise<any>

launchBulkEmailsOutbounds()​

launchBulkEmailsOutbounds: (outboundId) => Promise<any>

Parameters​

outboundId​

string

Returns​

Promise<any>

linkUserWithContact()​

linkUserWithContact: (userId, contactId) => Promise<any>

Parameters​

userId​

any

contactId​

any

Returns​

Promise<any>

login()​

login: (handle, password) => Promise<any>

Parameters​

handle​

any

password​

any

Returns​

Promise<any>

logout()​

logout: () => Promise<any>

Returns​

Promise<any>

makeItemPrivate()​

makeItemPrivate: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

makeItemPublic()​

makeItemPublic: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

makeSpacePrivate()​

makeSpacePrivate: (spaceId) => Promise<any>

Parameters​

spaceId​

string

Returns​

Promise<any>

makeSpacePublic()​

makeSpacePublic: (spaceId) => Promise<any>

Parameters​

spaceId​

string

Returns​

Promise<any>

postLinkedinShare()​

postLinkedinShare: (linkedinUser, postText, accessToken) => Promise<any>

Parameters​

linkedinUser​

ILinkedInUser

postText​

string

accessToken​

string

Returns​

Promise<any>

postLinkedinShareWithUpload()​

postLinkedinShareWithUpload: (linkedinUser, postText, uploadObject, accessToken) => Promise<any>

Parameters​

linkedinUser​

ILinkedInUser

postText​

string

uploadObject​

string

accessToken​

string

Returns​

Promise<any>

proxyGET()​

proxyGET: (url, token) => Promise<any>

Parameters​

url​

string

token​

string

Returns​

Promise<any>

proxyPOST()​

proxyPOST: (url, body, token) => Promise<any>

Parameters​

url​

string

body​

object

token​

string

Returns​

Promise<any>

proxyPUT()​

proxyPUT: (url, body, token) => Promise<any>

Parameters​

url​

string

body​

object

token​

string

Returns​

Promise<any>

putInvite()​

putInvite: (token) => Promise<any>

Parameters​

token​

string

Returns​

Promise<any>

refreshAccount()​

refreshAccount: (accountHandle) => Promise<any>

Parameters​

accountHandle​

string

Returns​

Promise<any>

refreshAssignment()​

refreshAssignment: (assignmentId) => Promise<any>

Parameters​

assignmentId​

string

Returns​

Promise<any>

refreshAssignmentForStudent()​

refreshAssignmentForStudent: (courseId, user, assignmentId) => Promise<any>

Parameters​

courseId​

string

user​

IUser

assignmentId​

string

Returns​

Promise<any>

refreshCell()​

refreshCell: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

refreshContact()​

refreshContact: (contactId) => Promise<any>

Parameters​

contactId​

string

Returns​

Promise<any>

refreshCourse()​

refreshCourse: (courseId) => Promise<any>

Parameters​

courseId​

string

Returns​

Promise<any>

refreshCoursesEnrollments()​

refreshCoursesEnrollments: () => Promise<any>

Returns​

Promise<any>

refreshDataset()​

refreshDataset: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

refreshDatasource()​

refreshDatasource: (datasourceId) => Promise<any>

Parameters​

datasourceId​

string

Returns​

Promise<any>

refreshDatasources()​

refreshDatasources: () => Promise<any>

Returns​

Promise<any>

refreshDocument()​

refreshDocument: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

refreshEnvironment()​

refreshEnvironment: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

refreshExercise()​

refreshExercise: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

refreshInbound()​

refreshInbound: (userId) => Promise<any>

Parameters​

userId​

string

Returns​

Promise<any>

refreshInstructorCourses()​

refreshInstructorCourses: () => Promise<any>

Returns​

Promise<any>

refreshInvite()​

refreshInvite: (token) => Promise<any>

Parameters​

token​

string

Returns​

Promise<any>

refreshInvites()​

refreshInvites: (accountId) => Promise<any>

Parameters​

accountId​

string

Returns​

Promise<any>

refreshLayout()​

refreshLayout: (accountHandle, spaceHandle?, user?) => Promise<any>

Parameters​

accountHandle​

string

spaceHandle?​

string

user?​

IUser

Returns​

Promise<any>

refreshLesson()​

refreshLesson: (id) => Promise<any>

Parameters​

id​

string

Returns​

Promise<any>

refreshNotebook()​

refreshNotebook: (notebookId) => Promise<any>

Parameters​

notebookId​

string

Returns​

Promise<any>

refreshOrganization()​

refreshOrganization: (user, organizationId) => Promise<any>

Parameters​

user​

IUser

organizationId​

string

Returns​

Promise<any>

refreshOrganizationSpace()​

refreshOrganizationSpace: (organizationId, spaceId) => Promise<any>

Parameters​

organizationId​

string

spaceId​

string

Returns​

Promise<any>

refreshOrganizationSpaces()​

refreshOrganizationSpaces: (organizationId) => Promise<any>

Parameters​

organizationId​

string

Returns​

Promise<any>

refreshOutbound()​

refreshOutbound: (outboundId) => Promise<any>

Parameters​

outboundId​

string

Returns​

Promise<any>

refreshPage()​

refreshPage: (pageId) => Promise<any>

Parameters​

pageId​

string

Returns​

Promise<any>

refreshPages()​

refreshPages: () => Promise<any>

Returns​

Promise<any>

refreshPublicCourses()​

refreshPublicCourses: () => Promise<any>

Returns​

Promise<any>

refreshPublicItems()​

refreshPublicItems: () => Promise<any>

Returns​

Promise<any>

refreshSchools()​

refreshSchools: () => Promise<any>

Returns​

Promise<any>

refreshSecret()​

refreshSecret: (secretId) => Promise<any>

Parameters​

secretId​

string

Returns​

Promise<any>

refreshSecrets()​

refreshSecrets: () => Promise<any>

Returns​

Promise<any>

refreshSpaceAssignments()​

refreshSpaceAssignments: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshSpaceCells()​

refreshSpaceCells: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshSpaceDatasets()​

refreshSpaceDatasets: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshSpaceDocuments()​

refreshSpaceDocuments: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshSpaceEnvironments()​

refreshSpaceEnvironments: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshSpaceExercises()​

refreshSpaceExercises: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshSpaceItems()​

refreshSpaceItems: (spaceId) => Promise<any>

Parameters​

spaceId​

string

Returns​

Promise<any>

refreshSpaceLessons()​

refreshSpaceLessons: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshSpaceNotebooks()​

refreshSpaceNotebooks: (space, organization?) => Promise<any>

Parameters​

space​

IAnySpace

organization?​

IAnyOrganization

Returns​

Promise<any>

refreshStripePrices()​

refreshStripePrices: () => Promise<IRESTBaseResponse & object>

Returns​

Promise<IRESTBaseResponse & object>

refreshStudent()​

refreshStudent: (courseId, studentHandle) => Promise<any>

Parameters​

courseId​

any

studentHandle​

any

Returns​

Promise<any>

refreshTeam()​

refreshTeam: (teamId, organizationId) => Promise<any>

Parameters​

teamId​

string

organizationId​

string

Returns​

Promise<any>

refreshTeams()​

refreshTeams: (organizationId) => Promise<any>

Parameters​

organizationId​

string

Returns​

Promise<any>

refreshToken()​

refreshToken: (tokenId) => Promise<any>

Parameters​

tokenId​

string

Returns​

Promise<any>

refreshTokens()​

refreshTokens: () => Promise<any>

Returns​

Promise<any>

refreshUser()​

refreshUser: (userId) => Promise<any>

Parameters​

userId​

string

Returns​

Promise<any>

refreshUserOrganizations()​

refreshUserOrganizations: (user) => Promise<any>

Parameters​

user​

IUser

Returns​

Promise<any>

refreshUserSpace()​

refreshUserSpace: (userId, spaceId) => Promise<any>

Parameters​

userId​

string

spaceId​

string

Returns​

Promise<any>

refreshUserSpaces()​

refreshUserSpaces: () => Promise<any>

Returns​

Promise<any>

registerToWaitingList()​

registerToWaitingList: (formData) => void

Parameters​

formData​

WaitingListFormData

Returns​

void

removeMemberFromOrganization()​

removeMemberFromOrganization: (organizationId, userId) => Promise<any>

Parameters​

organizationId​

string

userId​

string

Returns​

Promise<any>

removeMemberFromOrganizationSpace()​

removeMemberFromOrganizationSpace: (organizationId, spaceId, accountId) => Promise<any>

Parameters​

organizationId​

string

spaceId​

string

accountId​

string

Returns​

Promise<any>

removeMemberFromTeam()​

removeMemberFromTeam: (teamId, userId) => Promise<any>

Parameters​

teamId​

string

userId​

string

Returns​

Promise<any>

removeRoleFromOrganizationMember()​

removeRoleFromOrganizationMember: (organizationId, userId, roleName) => Promise<any>

Parameters​

organizationId​

string

userId​

string

roleName​

string

Returns​

Promise<any>

removeRoleFromTeamMember()​

removeRoleFromTeamMember: (teamId, userId, roleName) => Promise<any>

Parameters​

teamId​

string

userId​

string

roleName​

string

Returns​

Promise<any>

removeStudentFromCourse()​

removeStudentFromCourse: (courseId, studentId) => Promise<any>

Parameters​

courseId​

string

studentId​

string

Returns​

Promise<any>

requestEmailUpdate()​

requestEmailUpdate: (email) => Promise<any>

Parameters​

email​

any

Returns​

Promise<any>

requestInvite()​

requestInvite: (firstName, lastName, email, socialUrl) => Promise<any>

Parameters​

firstName​

string

lastName​

string

email​

string

socialUrl​

string

Returns​

Promise<any>

requestJoin()​

requestJoin: (handle, email, firstName, lastName, password, passwordConfirm) => Promise<any>

Parameters​

handle​

any

email​

any

firstName​

any

lastName​

any

password​

any

passwordConfirm​

any

Returns​

Promise<any>

requestJoinToken()​

requestJoinToken: (handle, email, firstName, lastName, password, passwordConfirm) => Promise<any>

Parameters​

handle​

any

email​

any

firstName​

any

lastName​

any

password​

any

passwordConfirm​

any

Returns​

Promise<any>

requestPlatformSupport()​

requestPlatformSupport: (subject, message, email, brand) => Promise<any>

Parameters​

subject​

any

message​

any

email​

any

brand​

any

Returns​

Promise<any>

requestPlatformSupport2()​

requestPlatformSupport2: (accountHandle, firstName, lastName, email, message) => Promise<any>

Parameters​

accountHandle​

any

firstName​

any

lastName​

any

email​

any

message​

any

Returns​

Promise<any>

resetAssignmentForStudent()​

resetAssignmentForStudent: (courseId, user, assignmentId) => Promise<any>

Parameters​

courseId​

string

user​

IUser

assignmentId​

string

Returns​

Promise<any>

searchContacts()​

searchContacts: (query) => Promise<any>

Parameters​

query​

string

Returns​

Promise<any>

searchPublicItems()​

searchPublicItems: (opts) => Promise<any>

Parameters​

opts​

ISearchOpts = DEFAULT_SEARCH_OPTS

Returns​

Promise<any>

searchUsers()​

searchUsers: (namingPattern) => Promise<any>

Parameters​

namingPattern​

string

Returns​

Promise<any>

sendInvite()​

sendInvite: (invite) => Promise<any>

Parameters​

invite​

IInvite

Returns​

Promise<any>

sendInviteToContact()​

sendInviteToContact: (contact, message) => Promise<any>

Parameters​

contact​

IContact

message​

string

Returns​

Promise<any>

sendLinkedinConnectionRequest()​

sendLinkedinConnectionRequest: (contact, message) => Promise<any>

Parameters​

contact​

IContact

message​

string

Returns​

Promise<any>

sendOutboundEmailToUser()​

sendOutboundEmailToUser: (userId, recipient, subject, content) => Promise<any>

Parameters​

userId​

string

recipient​

string

subject​

string

content​

string

Returns​

Promise<any>

setCourseItems()​

setCourseItems: (courseId, itemIds) => Promise<any>

Parameters​

courseId​

any

itemIds​

any

Returns​

Promise<any>

subscribeUserToOutbounds()​

subscribeUserToOutbounds: (userId) => Promise<any>

Parameters​

userId​

string

Returns​

Promise<any>

toInbound()​

toInbound: (u) => undefined | IInbound

Parameters​

u​

any

Returns​

undefined | IInbound

toOutbound()​

toOutbound: (u) => undefined | IOutbound

Parameters​

u​

any

Returns​

undefined | IOutbound

tryBulkEmailsOutbounds()​

tryBulkEmailsOutbounds: (outboundId) => Promise<any>

Parameters​

outboundId​

string

Returns​

Promise<any>

unassignRoleFromUser()​

unassignRoleFromUser: (userId, roleName) => Promise<any>

Parameters​

userId​

any

roleName​

any

Returns​

Promise<any>

unassignTagFromContact()​

unassignTagFromContact: (contactId, tagName) => Promise<any>

Parameters​

contactId​

any

tagName​

any

Returns​

Promise<any>

unlinkUserFromContact()​

unlinkUserFromContact: (userId, contactId) => Promise<any>

Parameters​

userId​

any

contactId​

any

Returns​

Promise<any>

unsubscribeContactFromOutbounds()​

unsubscribeContactFromOutbounds: (contactId) => Promise<any>

Parameters​

contactId​

string

Returns​

Promise<any>

unsubscribeInviteeFromOutbounds()​

unsubscribeInviteeFromOutbounds: (token) => Promise<any>

Parameters​

token​

string

Returns​

Promise<any>

unsubscribeUserFromOutbounds()​

unsubscribeUserFromOutbounds: (userId) => Promise<any>

Parameters​

userId​

string

Returns​

Promise<any>

updateCell()​

updateCell: (cell) => Promise<any>

Parameters​

cell​
description​

string

id​

string

name​

string

outputshotData?​

string

outputshotUrl?​

string

source​

string

spaceId​

string

Returns​

Promise<any>

updateContact()​

updateContact: (contactId, contact) => Promise<any>

Parameters​

contactId​

any

contact​

IContact

Returns​

Promise<any>

updateCourse()​

updateCourse: (courseId, name, description) => Promise<any>

Parameters​

courseId​

any

name​

any

description​

any

Returns​

Promise<any>

updateDataset()​

updateDataset: (id, name, description) => Promise<any>

Parameters​

id​

any

name​

any

description​

any

Returns​

Promise<any>

updateDatasource()​

updateDatasource: (datasource) => Promise<any>

Parameters​

datasource​

IDatasource

Returns​

Promise<any>

updateDocument()​

updateDocument: (id, name, description) => Promise<any>

Parameters​

id​

any

name​

any

description​

any

Returns​

Promise<any>

updateDocumentModel()​

updateDocumentModel: (id, model) => Promise<any>

Parameters​

id​

any

model​

any

Returns​

Promise<any>

updateExercise()​

updateExercise: (__namedParameters) => Promise<any>

Parameters​

__namedParameters​
codePre​

any

codeQuestion​

any

codeSolution​

any

codeTest​

any

description​

any

help​

any

id​

any

name​

any

Returns​

Promise<any>

updateExercisePoints()​

updateExercisePoints: (id, codeStudent, points) => Promise<any>

Parameters​

id​

any

codeStudent​

any

points​

any

Returns​

Promise<any>

updateMe()​

updateMe: (email, firstName, lastName) => Promise<any>

Parameters​

email​

any

firstName​

any

lastName​

any

Returns​

Promise<any>

updateNotebook()​

updateNotebook: (id, name, description) => Promise<any>

Parameters​

id​

any

name​

any

description​

any

Returns​

Promise<any>

updateNotebookModel()​

updateNotebookModel: (notebookId, nbformat) => Promise<any>

Parameters​

notebookId​

any

nbformat​

any

Returns​

Promise<any>

updateOrganization()​

updateOrganization: (organization) => Promise<any>

Parameters​

organization​

Partial<IAnyOrganization>

Returns​

Promise<any>

updateOrganizationSpace()​

updateOrganizationSpace: (organization, space) => Promise<any>

Parameters​

organization​

IAnyOrganization

space​

Partial<IAnySpace>

Returns​

Promise<any>

updatePage()​

updatePage: (page) => Promise<any>

Parameters​

page​

Pick<IPage, "id" | "name" | "description" | "tags">

Returns​

Promise<any>

updateSecret()​

updateSecret: (secret) => Promise<any>

Parameters​

secret​

ISecret

Returns​

Promise<any>

updateSpace()​

updateSpace: (space) => Promise<any>

Parameters​

space​

Partial<IAnySpace>

Returns​

Promise<any>

updateTeam()​

updateTeam: (team) => Promise<any>

Parameters​

team​

Partial<ITeam>

Returns​

Promise<any>

updateToken()​

updateToken: (token) => Promise<any>

Parameters​

token​

IIAMToken

Returns​

Promise<any>

updateUserCredits()​

updateUserCredits: (userId, credits, brand) => Promise<any>

Parameters​

userId​

any

credits​

any

brand​

any

Returns​

Promise<any>

updateUserCreditsQuota()​

updateUserCreditsQuota: (userId, quota?) => Promise<any>

Parameters​

userId​

string

quota?​

number

Returns​

Promise<any>

updateUserOnboarding()​

updateUserOnboarding: (onboarding) => Promise<any>

Parameters​

onboarding​

IUserOnboarding

Returns​

Promise<any>

updateUserSettings()​

updateUserSettings: (userId, settings) => Promise<any>

Parameters​

userId​

string

settings​

IUserSettings

Returns​

Promise<any>

validateUserMFACode()​

validateUserMFACode: (userUid, code) => Promise<any>

Parameters​

userUid​

any

code​

string

Returns​

Promise<any>

whoami()​

whoami: () => Promise<any>

Returns​

Promise<any>