Avaya Client SDK

< Back to Package Overview

Retrieving programs

All methods requre ProgramParams parameter. This object has many properties. Not all of them are needed for each method, but there are two mandatory properties:

  • tenantId
  • user

Parameter user used only for authorized user. Next, we consider that these parameters are already contained.

Retrieve recordings by common method:

This method's parameter can comprise the following properties:

Property
query
offset
count
orderBy
orderBy2
category
ownerId
onlyDeleted
client.programService.getRecordedPrograms(programParameters)
    .done(function(response){
        // response contains programs
    });

Retrieve recordings by category:

This method's parameter can comprise the following properties:

Property
offset
count
client.programService.getRecordedProgramsByCategory(programParameters)
    .done(function(response){
        // response contains programs
    });

Retrieve recordings by publisher:

This method's parameter can comprise the following properties:

Property
offset
count
onlyDeleted
client.programService.getRecordedProgramsByPublisher(programParameters)
    .done(function(response){
        // response contains programs
    });

Get an Individual Program

client.programService.getPrograms(programId, programParameters)
    .done(function(response){
        // response contains program
    });

Get a Password Protected Program

client.programService
    .getPasswordProtectedProgram(programId, password, programParameters)
        .done(function(response){
        // response contains program
    });

Get an Individual Program's playback address details

client.programService
    .getProgramPlaybackAddressDetails(programId, password, programParameters)
        .done(function(response){
        // response contains address details
    });

Get Status of Program

client.programService.getProgramStatus(programId, programParameters)
        .done(function(response){
        // response contains status
    });