Package com.kaltura.client.services

Class PartnerService

java.lang.Object

com.kaltura.client.services.PartnerService

public class PartnerService
extends Object

partner service allows you to change/manage your partner personal details and settings as well

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PartnerService.CountPartnerBuilder
static class	PartnerService.GetInfoPartnerBuilder
static class	PartnerService.GetPartnerBuilder
static class	PartnerService.GetPublicInfoPartnerBuilder
static class	PartnerService.GetSecretsPartnerBuilder
static class	PartnerService.GetStatisticsPartnerBuilder
static class	PartnerService.GetUsagePartnerBuilder
static class	PartnerService.ListFeatureStatusPartnerBuilder
static class	PartnerService.ListPartnerBuilder
static class	PartnerService.ListPartnersForUserPartnerBuilder
static class	PartnerService.RegisterPartnerBuilder
static class	PartnerService.RegistrationValidationPartnerBuilder
static class	PartnerService.UpdatePartnerBuilder

Constructor Summary

Constructors

Constructor	Description
PartnerService()

Method Summary

Modifier and Type	Method	Description
static PartnerService.CountPartnerBuilder	count()
static PartnerService.CountPartnerBuilder	count(PartnerFilter filter)	Count partner's existing sub-publishers (count includes the partner itself).
static PartnerService.GetPartnerBuilder	get()
static PartnerService.GetPartnerBuilder	get(long id)	Retrieve partner object by Id
static PartnerService.GetInfoPartnerBuilder	getInfo()	Retrieve all info attributed to the partner This action expects no parameters.
static PartnerService.GetPublicInfoPartnerBuilder	getPublicInfo()
static PartnerService.GetPublicInfoPartnerBuilder	getPublicInfo(long id)	Returns partner public info by Id
static PartnerService.GetSecretsPartnerBuilder	getSecrets(int partnerId, String adminEmail, String cmsPassword)
static PartnerService.GetSecretsPartnerBuilder	getSecrets(int partnerId, String adminEmail, String cmsPassword, String otp)	Retrieve partner secret and admin secret
static PartnerService.GetStatisticsPartnerBuilder	getStatistics()	Get usage statistics for a partner Calculation is done according to partner's package
static PartnerService.GetUsagePartnerBuilder	getUsage()
static PartnerService.GetUsagePartnerBuilder	getUsage(int year)
static PartnerService.GetUsagePartnerBuilder	getUsage(int year, int month)
static PartnerService.GetUsagePartnerBuilder	getUsage(int year, int month, ReportInterval resolution)	Get usage statistics for a partner Calculation is done according to partner's package Additional data returned is a graph points of streaming usage in a time frame The resolution can be "days" or "months"
static PartnerService.ListPartnerBuilder	list()
static PartnerService.ListPartnerBuilder	list(PartnerFilter filter)
static PartnerService.ListPartnerBuilder	list(PartnerFilter filter, FilterPager pager)	List partners by filter with paging support Current implementation will only list the sub partners of the partner initiating the API call (using the current KS).
static PartnerService.ListFeatureStatusPartnerBuilder	listFeatureStatus()	List partner's current processes' statuses
static PartnerService.ListPartnersForUserPartnerBuilder	listPartnersForUser()
static PartnerService.ListPartnersForUserPartnerBuilder	listPartnersForUser(PartnerFilter partnerFilter)
static PartnerService.ListPartnersForUserPartnerBuilder	listPartnersForUser(PartnerFilter partnerFilter, FilterPager pager)	Retrieve a list of partner objects which the current user is allowed to access.
static PartnerService.RegisterPartnerBuilder	register(Partner partner)
static PartnerService.RegisterPartnerBuilder	register(Partner partner, String cmsPassword)
static PartnerService.RegisterPartnerBuilder	register(Partner partner, String cmsPassword, int templatePartnerId)
static PartnerService.RegisterPartnerBuilder	register(Partner partner, String cmsPassword, int templatePartnerId, boolean silent)	Create a new Partner object
static PartnerService.RegistrationValidationPartnerBuilder	registrationValidation(Partner partner)
static PartnerService.RegistrationValidationPartnerBuilder	registrationValidation(Partner partner, String cmsPassword)
static PartnerService.RegistrationValidationPartnerBuilder	registrationValidation(Partner partner, String cmsPassword, int templatePartnerId)
static PartnerService.RegistrationValidationPartnerBuilder	registrationValidation(Partner partner, String cmsPassword, int templatePartnerId, boolean silent)	Create a new Partner object
static PartnerService.UpdatePartnerBuilder	update(Partner partner)
static PartnerService.UpdatePartnerBuilder	update(Partner partner, boolean allowEmpty)	Update details and settings of an existing partner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartnerService

public PartnerService()

Method Detail

count

public static PartnerService.CountPartnerBuilder count()

count

public static PartnerService.CountPartnerBuilder count(PartnerFilter filter)

Count partner's existing sub-publishers (count includes the partner itself).

Parameters:

filter -

get

public static PartnerService.GetPartnerBuilder get()

get

public static PartnerService.GetPartnerBuilder get(long id)

Retrieve partner object by Id

Parameters:

id -

getInfo

public static PartnerService.GetInfoPartnerBuilder getInfo()

Retrieve all info attributed to the partner This action expects no parameters. It returns information for the current KS partnerId.

getPublicInfo

public static PartnerService.GetPublicInfoPartnerBuilder getPublicInfo()

getPublicInfo

public static PartnerService.GetPublicInfoPartnerBuilder getPublicInfo(long id)

Returns partner public info by Id

Parameters:

id -

getSecrets

public static PartnerService.GetSecretsPartnerBuilder getSecrets(int partnerId,
                                                                 String adminEmail,
                                                                 String cmsPassword)

getSecrets

public static PartnerService.GetSecretsPartnerBuilder getSecrets(int partnerId,
                                                                 String adminEmail,
                                                                 String cmsPassword,
                                                                 String otp)

Retrieve partner secret and admin secret

Parameters:

partnerId -

adminEmail -

cmsPassword -

otp -

getStatistics

public static PartnerService.GetStatisticsPartnerBuilder getStatistics()

Get usage statistics for a partner Calculation is done according to partner's package

getUsage

public static PartnerService.GetUsagePartnerBuilder getUsage()

getUsage

public static PartnerService.GetUsagePartnerBuilder getUsage(int year)

getUsage

public static PartnerService.GetUsagePartnerBuilder getUsage(int year,
                                                             int month)

getUsage

public static PartnerService.GetUsagePartnerBuilder getUsage(int year,
                                                             int month,
                                                             ReportInterval resolution)

Get usage statistics for a partner Calculation is done according to partner's package Additional data returned is a graph points of streaming usage in a time frame The resolution can be "days" or "months"

Parameters:

year -

month -

resolution -

list

public static PartnerService.ListPartnerBuilder list()

list

public static PartnerService.ListPartnerBuilder list(PartnerFilter filter)

list

public static PartnerService.ListPartnerBuilder list(PartnerFilter filter,
                                                     FilterPager pager)

List partners by filter with paging support Current implementation will only list the sub partners of the partner initiating the API call (using the current KS). This action is only partially implemented to support listing sub partners of a VAR partner.

Parameters:

filter -

pager -

listFeatureStatus

public static PartnerService.ListFeatureStatusPartnerBuilder listFeatureStatus()

List partner's current processes' statuses

listPartnersForUser

public static PartnerService.ListPartnersForUserPartnerBuilder listPartnersForUser()

listPartnersForUser

public static PartnerService.ListPartnersForUserPartnerBuilder listPartnersForUser(PartnerFilter partnerFilter)

listPartnersForUser

public static PartnerService.ListPartnersForUserPartnerBuilder listPartnersForUser(PartnerFilter partnerFilter,
                                                                                   FilterPager pager)

Retrieve a list of partner objects which the current user is allowed to access.

Parameters:

partnerFilter -

pager -

register

public static PartnerService.RegisterPartnerBuilder register(Partner partner)

register

public static PartnerService.RegisterPartnerBuilder register(Partner partner,
                                                             String cmsPassword)

register

public static PartnerService.RegisterPartnerBuilder register(Partner partner,
                                                             String cmsPassword,
                                                             int templatePartnerId)

register

public static PartnerService.RegisterPartnerBuilder register(Partner partner,
                                                             String cmsPassword,
                                                             int templatePartnerId,
                                                             boolean silent)

Create a new Partner object

Parameters:

partner -

cmsPassword -

templatePartnerId -

silent -

registrationValidation

public static PartnerService.RegistrationValidationPartnerBuilder registrationValidation(Partner partner)

registrationValidation

public static PartnerService.RegistrationValidationPartnerBuilder registrationValidation(Partner partner,
                                                                                         String cmsPassword)

registrationValidation

public static PartnerService.RegistrationValidationPartnerBuilder registrationValidation(Partner partner,
                                                                                         String cmsPassword,
                                                                                         int templatePartnerId)

registrationValidation

public static PartnerService.RegistrationValidationPartnerBuilder registrationValidation(Partner partner,
                                                                                         String cmsPassword,
                                                                                         int templatePartnerId,
                                                                                         boolean silent)

Create a new Partner object

Parameters:

partner -

cmsPassword -

templatePartnerId -

silent -

update

public static PartnerService.UpdatePartnerBuilder update(Partner partner)

update

public static PartnerService.UpdatePartnerBuilder update(Partner partner,
                                                         boolean allowEmpty)

Update details and settings of an existing partner

Parameters:

partner -

allowEmpty -