JobRouterClient class

Paket:: @azure/communication-job-router

Klienten för att utföra jobbrouteråtgärder.

Konstruktorer

JobRouterClient(string, CommunicationTokenCredential, JobRouterClientOptions)	Skapar en instans av JobRouterClient med hjälp av en TokenCredential.
JobRouterClient(string, JobRouterClientOptions)	Skapar en instans av JobRouterClient.
JobRouterClient(string, KeyCredential \| TokenCredential, JobRouterClientOptions)	Skapar en instans av JobRouterClient med hjälp av en Azure KeyCredential.

Metoder

acceptJobOffer(string, string, OperationOptions)	Accepterar ett jobberbjudande.
cancelJob(string, CancelJobOptions)	Avbryter ett jobb.
closeJob(string, string, CloseJobOptions)	Stänger ett jobb.
completeJob(string, string, CompleteJobOptions)	Slutför ett jobb.
createJob(string, CreateJobOptions)	Skapar ett jobb.
createWorker(string, CreateWorkerOptions)	Skapar en arbetare.
declineJobOffer(string, string, DeclineJobOfferOptions)	Avböjer ett jobberbjudande.
deleteJob(string, OperationOptions)	Tar bort ett jobb.
deleteWorker(string, OperationOptions)	Tar bort en arbetare.
getJob(string, OperationOptions)	Får ett jobb.
getJobQueuePosition(string, OperationOptions)	Får ett jobbs köposition.
getQueueStatistics(string, OperationOptions)	Hämtar statistik för en kö.
getWorker(string, OperationOptions)	Skaffar en arbetare.
listJobs(ListJobsOptions)	Hämtar en lista över jobb.
listWorkers(ListWorkersOptions)	Hämtar en lista över arbetare.
reclassifyJob(string, ReclassifyJobOptions)	Uppdaterar ett jobb och tvingar det att klassificeras om.
unassignJob(string, string, UnassignJobOptions)	Tar bort tilldelningen av ett jobb.
updateJob(string, UpdateJobOptions)	Uppdaterar ett jobb.
updateWorker(string, UpdateWorkerOptions)	Uppdaterar en arbetare.

Konstruktorinformation

JobRouterClient(string, CommunicationTokenCredential, JobRouterClientOptions)

Skapar en instans av JobRouterClient med hjälp av en TokenCredential.

new JobRouterClient(endpoint: string, credential: CommunicationTokenCredential, options?: JobRouterClientOptions)

Parametrar

endpoint: string

Tjänstens slutpunkt (till exempel https://contoso.eastus.communications.azure.net).

credential: CommunicationTokenCredential

CommunicationTokenCredential som används för att autentisera begäranden till tjänsten.

options: JobRouterClientOptions

(Valfritt) Alternativ för att konfigurera HTTP-pipelinen.

JobRouterClient(string, JobRouterClientOptions)

Skapar en instans av JobRouterClient.

new JobRouterClient(connectionString: string, options?: JobRouterClientOptions)

Parametrar

connectionString: string

Anslutningssträng för att ansluta till en Azure Communication Service-resurs. (t.ex. "slutpunkt=https://contoso.eastus.communications.azure.net/; accesskey=hemlig").

options: JobRouterClientOptions

(Valfritt) Alternativ för att konfigurera HTTP-pipelinen.

JobRouterClient(string, KeyCredential | TokenCredential, JobRouterClientOptions)

Skapar en instans av JobRouterClient med hjälp av en Azure KeyCredential.

new JobRouterClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: JobRouterClientOptions)

Parametrar

endpoint: string

Tjänstens slutpunkt (till exempel https://contoso.eastus.communications.azure.net).

credential: KeyCredential | TokenCredential

Ett objekt som används för att autentisera begäranden till tjänsten. Använd Azure KeyCredential eller @azure/identity eller TokenCredential för att skapa en autentiseringsuppgift.

options: JobRouterClientOptions

(Valfritt) usingOptions för att konfigurera HTTP-pipelinen.

Metodinformation

acceptJobOffer(string, string, OperationOptions)

Accepterar ett jobberbjudande.

function acceptJobOffer(workerId: string, offerId: string, options?: OperationOptions): Promise<AcceptJobOfferResponse>

Parametrar

workerId: string

ID för den arbetare som accepterar jobbet.

offerId: string

ID:t för erbjudandet som ska accepteras.

options: OperationOptions

Alternativ för att acceptera ett jobberbjudande.

Returer

Promise<AcceptJobOfferResponse>

cancelJob(string, CancelJobOptions)

Avbryter ett jobb.

function cancelJob(jobId: string, options?: CancelJobOptions): Promise<CancelJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska avbrytas.

options: CancelJobOptions

Alternativ för att avbryta ett jobb.

Returer

Promise<CancelJobResponse>

closeJob(string, string, CloseJobOptions)

Stänger ett jobb.

function closeJob(jobId: string, assignmentId: string, options?: CloseJobOptions): Promise<CloseJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska stängas.

assignmentId: string

Tilldelnings-ID:t som motsvarar jobbet som ska stängas.

options: CloseJobOptions

Alternativ för att stänga ett jobb.

Returer

Promise<CloseJobResponse>

completeJob(string, string, CompleteJobOptions)

Slutför ett jobb.

function completeJob(jobId: string, assignmentId: string, options?: CompleteJobOptions): Promise<CompleteJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska slutföras.

assignmentId: string

ID:t för tilldelningen som ska slutföras.

options: CompleteJobOptions

Alternativ för att slutföra ett jobb.

Returer

Promise<CompleteJobResponse>

createJob(string, CreateJobOptions)

Skapar ett jobb.

function createJob(jobId: string, options?: CreateJobOptions): Promise<RouterJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska skapas.

options: CreateJobOptions

Alternativ för att skapa ett jobb.

Returer

Promise<RouterJobResponse>

Det skapade jobbet.

createWorker(string, CreateWorkerOptions)

Skapar en arbetare.

function createWorker(workerId: string, options?: CreateWorkerOptions): Promise<RouterWorkerResponse>

Parametrar

workerId: string

ID:t för den arbetare som ska skapas.

options: CreateWorkerOptions

Alternativ för att skapa en arbetare.

Returer

Promise<RouterWorkerResponse>

Den skapade arbetaren.

declineJobOffer(string, string, DeclineJobOfferOptions)

Avböjer ett jobberbjudande.

function declineJobOffer(workerId: string, offerId: string, options?: DeclineJobOfferOptions): Promise<DeclineJobOfferResponse>

Parametrar

workerId: string

ID för den arbetare som innehar erbjudandet.

offerId: string

ID:t för erbjudandet som ska avvisas.

options: DeclineJobOfferOptions

Alternativ för att tacka nej till ett jobberbjudande.

Returer

Promise<DeclineJobOfferResponse>

deleteJob(string, OperationOptions)

Tar bort ett jobb.

function deleteJob(jobId: string, options?: OperationOptions): Promise<void>

Parametrar

jobId: string

ID:t för jobbet som ska tas bort.

options: OperationOptions

Alternativ för att ta bort ett jobb.

Returer

Promise<void>

deleteWorker(string, OperationOptions)

Tar bort en arbetare.

function deleteWorker(workerId: string, options?: OperationOptions): Promise<void>

Parametrar

workerId: string

ID:t för den arbetare som ska tas bort.

options: OperationOptions

Alternativ för att ta bort en arbetare.

Returer

Promise<void>

getJob(string, OperationOptions)

Får ett jobb.

function getJob(jobId: string, options?: OperationOptions): Promise<RouterJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska hämtas.

options: OperationOptions

Alternativ för att få ett jobb.

Returer

Promise<RouterJobResponse>

Jobbet.

getJobQueuePosition(string, OperationOptions)

Får ett jobbs köposition.

function getJobQueuePosition(jobId: string, options?: OperationOptions): Promise<RouterJobPositionDetails>

Parametrar

jobId: string

ID:t för jobbet som du vill hämta köpositionen för.

options: OperationOptions

Alternativ för att få ett jobbs köposition.

Returer

Promise<RouterJobPositionDetails>

Jobbets köposition.

getQueueStatistics(string, OperationOptions)

Hämtar statistik för en kö.

function getQueueStatistics(queueId: string, options?: OperationOptions): Promise<RouterQueueStatistics>

Parametrar

queueId: string

ID:t för kön som du vill få statistik över.

options: OperationOptions

Alternativ för att hämta statistik för en kö.

Returer

Promise<RouterQueueStatistics>

Köns statistik.

getWorker(string, OperationOptions)

Skaffar en arbetare.

function getWorker(workerId: string, options?: OperationOptions): Promise<RouterWorkerResponse>

Parametrar

workerId: string

ID:t för den arbetare som ska hämtas.

options: OperationOptions

Alternativ för att få en arbetare.

Returer

Promise<RouterWorkerResponse>

Arbetaren.

listJobs(ListJobsOptions)

Hämtar en lista över jobb.

function listJobs(options?: ListJobsOptions): TransformingPagedAsyncIterableIterator<RouterJobItem_2, RouterJobItem, RouterJobItem_2[], RouterJobItem[], PageSettings>

Parametrar

options: ListJobsOptions

Alternativ för att lista jobb.

Returer

TransformingPagedAsyncIterableIterator<RouterJobItem_2, RouterJobItem, RouterJobItem_2[], RouterJobItem[], PageSettings>

Listan över jobb.

listWorkers(ListWorkersOptions)

Hämtar en lista över arbetare.

function listWorkers(options?: ListWorkersOptions): TransformingPagedAsyncIterableIterator<RouterWorkerItem_2, RouterWorkerItem, RouterWorkerItem_2[], RouterWorkerItem[], PageSettings>

Parametrar

options: ListWorkersOptions

Alternativ för att lista arbetare.

Returer

TransformingPagedAsyncIterableIterator<RouterWorkerItem_2, RouterWorkerItem, RouterWorkerItem_2[], RouterWorkerItem[], PageSettings>

Listan över arbetare.

reclassifyJob(string, ReclassifyJobOptions)

Uppdaterar ett jobb och tvingar det att klassificeras om.

function reclassifyJob(jobId: string, options?: ReclassifyJobOptions): Promise<ReclassifyJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska omklassificeras.

options: ReclassifyJobOptions

Alternativ för att omklassificera ett jobb.

Returer

Promise<ReclassifyJobResponse>

unassignJob(string, string, UnassignJobOptions)

Tar bort tilldelningen av ett jobb.

function unassignJob(jobId: string, assignmentId: string, options?: UnassignJobOptions): Promise<UnassignJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska tas bort.

assignmentId: string

Det tilldelnings-ID som motsvarar det jobb som ska tas bort.

options: UnassignJobOptions

Alternativ för att ta bort tilldelningen av ett jobb.

Returer

Promise<UnassignJobResponse>

updateJob(string, UpdateJobOptions)

Uppdaterar ett jobb.

function updateJob(jobId: string, options?: UpdateJobOptions): Promise<RouterJobResponse>

Parametrar

jobId: string

ID:t för jobbet som ska uppdateras.

options: UpdateJobOptions

Alternativ för att uppdatera ett jobb. Använder merge-patch-semantik: https://datatracker.ietf.org/doc/html/rfc7386.

Returer

Promise<RouterJobResponse>

Det uppdaterade jobbet.

updateWorker(string, UpdateWorkerOptions)

Uppdaterar en arbetare.

function updateWorker(workerId: string, options?: UpdateWorkerOptions): Promise<RouterWorkerResponse>

Parametrar

workerId: string

ID:t för den arbetare som ska uppdateras.

options: UpdateWorkerOptions

Alternativ för att uppdatera en arbetare. Använder merge-patch-semantik: https://datatracker.ietf.org/doc/html/rfc7386.

Returer

Promise<RouterWorkerResponse>

Den uppdaterade arbetaren.

Feedback

Var den här sidan till hjälp?