com.kaltura.client.services.OttUserService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of KalturaOttApiClient Show documentation
Show all versions of KalturaOttApiClient Show documentation
KalturaOttApiClient is a library of Java classes that can be used to interact
with the Kaltura OTT REST API. More information about the REST API can be
found at https://ott.developer.kaltura.com/ Many of the Java classes
in this library are auto-generated from a schema that defines the objects that
are used to interact with the API.
// ===================================================================================================
// _ __ _ _
// | |/ /__ _| | |_ _ _ _ _ __ _
// | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;
import com.kaltura.client.types.LoginResponse;
import com.kaltura.client.types.LoginSession;
import com.kaltura.client.types.OTTUser;
import com.kaltura.client.types.OTTUserFilter;
import com.kaltura.client.types.StringValue;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.NullRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import java.util.Map;
/**
* This class was generated using clients-generator\exec.php
* against an XML schema provided by Kaltura.
*
* MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
*/
public class OttUserService {
public static class ActivateOttUserBuilder extends RequestBuilder {
public ActivateOttUserBuilder(int partnerId, String username, String activationToken) {
super(OTTUser.class, "ottuser", "activate");
params.add("partnerId", partnerId);
params.add("username", username);
params.add("activationToken", activationToken);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void username(String multirequestToken) {
params.add("username", multirequestToken);
}
public void activationToken(String multirequestToken) {
params.add("activationToken", multirequestToken);
}
}
/**
* Activate the account by activation token
*
* @param partnerId The partner ID
* @param username Username of the user to activate
* @param activationToken Activation token of the user
*/
public static ActivateOttUserBuilder activate(int partnerId, String username, String activationToken) {
return new ActivateOttUserBuilder(partnerId, username, activationToken);
}
public static class AddRoleOttUserBuilder extends RequestBuilder {
public AddRoleOttUserBuilder(long roleId) {
super(Boolean.class, "ottuser", "addRole");
params.add("roleId", roleId);
}
public void roleId(String multirequestToken) {
params.add("roleId", multirequestToken);
}
}
/**
* Edit user details.
*
* @param roleId The role identifier to add
*/
public static AddRoleOttUserBuilder addRole(long roleId) {
return new AddRoleOttUserBuilder(roleId);
}
public static class AnonymousLoginOttUserBuilder extends RequestBuilder {
public AnonymousLoginOttUserBuilder(int partnerId, String udid) {
super(LoginSession.class, "ottuser", "anonymousLogin");
params.add("partnerId", partnerId);
params.add("udid", udid);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void udid(String multirequestToken) {
params.add("udid", multirequestToken);
}
}
public static AnonymousLoginOttUserBuilder anonymousLogin(int partnerId) {
return anonymousLogin(partnerId, null);
}
/**
* Returns tokens (KS and refresh token) for anonymous access
*
* @param partnerId The partner ID
* @param udid The caller device's UDID
*/
public static AnonymousLoginOttUserBuilder anonymousLogin(int partnerId, String udid) {
return new AnonymousLoginOttUserBuilder(partnerId, udid);
}
public static class DeleteOttUserBuilder extends RequestBuilder {
public DeleteOttUserBuilder() {
super(Boolean.class, "ottuser", "delete");
}
}
/**
* Permanently delete a user. User to delete cannot be an exclusive household
master, and cannot be default user.
*/
public static DeleteOttUserBuilder delete() {
return new DeleteOttUserBuilder();
}
public static class GetOttUserBuilder extends RequestBuilder {
public GetOttUserBuilder() {
super(OTTUser.class, "ottuser", "get");
}
}
/**
* Retrieving users' data
*/
public static GetOttUserBuilder get() {
return new GetOttUserBuilder();
}
public static class GetEncryptedUserIdOttUserBuilder extends RequestBuilder {
public GetEncryptedUserIdOttUserBuilder() {
super(StringValue.class, "ottuser", "getEncryptedUserId");
}
}
/**
* Returns the identifier of the user encrypted with SHA1 using configured key
*/
public static GetEncryptedUserIdOttUserBuilder getEncryptedUserId() {
return new GetEncryptedUserIdOttUserBuilder();
}
public static class ListOttUserBuilder extends ListResponseRequestBuilder {
public ListOttUserBuilder(OTTUserFilter filter) {
super(OTTUser.class, "ottuser", "list");
params.add("filter", filter);
}
}
public static ListOttUserBuilder list() {
return list(null);
}
/**
* Retrieve user by external identifier or username or if filter is null all user
in the master or the user itself
*
* @param filter Filter request
*/
public static ListOttUserBuilder list(OTTUserFilter filter) {
return new ListOttUserBuilder(filter);
}
public static class LoginOttUserBuilder extends RequestBuilder {
public LoginOttUserBuilder(int partnerId, String username, String password, Map extraParams, String udid) {
super(LoginResponse.class, "ottuser", "login");
params.add("partnerId", partnerId);
params.add("username", username);
params.add("password", password);
params.add("extraParams", extraParams);
params.add("udid", udid);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void username(String multirequestToken) {
params.add("username", multirequestToken);
}
public void password(String multirequestToken) {
params.add("password", multirequestToken);
}
public void udid(String multirequestToken) {
params.add("udid", multirequestToken);
}
}
public static LoginOttUserBuilder login(int partnerId) {
return login(partnerId, null);
}
public static LoginOttUserBuilder login(int partnerId, String username) {
return login(partnerId, username, null);
}
public static LoginOttUserBuilder login(int partnerId, String username, String password) {
return login(partnerId, username, password, null);
}
public static LoginOttUserBuilder login(int partnerId, String username, String password, Map extraParams) {
return login(partnerId, username, password, extraParams, null);
}
/**
* login with user name and password.
*
* @param partnerId Partner Identifier
* @param username user name
* @param password password
* @param extraParams extra params
* @param udid Device UDID
*/
public static LoginOttUserBuilder login(int partnerId, String username, String password, Map extraParams, String udid) {
return new LoginOttUserBuilder(partnerId, username, password, extraParams, udid);
}
public static class LoginWithPinOttUserBuilder extends RequestBuilder {
public LoginWithPinOttUserBuilder(int partnerId, String pin, String udid, String secret) {
super(LoginResponse.class, "ottuser", "loginWithPin");
params.add("partnerId", partnerId);
params.add("pin", pin);
params.add("udid", udid);
params.add("secret", secret);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void pin(String multirequestToken) {
params.add("pin", multirequestToken);
}
public void udid(String multirequestToken) {
params.add("udid", multirequestToken);
}
public void secret(String multirequestToken) {
params.add("secret", multirequestToken);
}
}
public static LoginWithPinOttUserBuilder loginWithPin(int partnerId, String pin) {
return loginWithPin(partnerId, pin, null);
}
public static LoginWithPinOttUserBuilder loginWithPin(int partnerId, String pin, String udid) {
return loginWithPin(partnerId, pin, udid, null);
}
/**
* User sign-in via a time-expired sign-in PIN.
*
* @param partnerId Partner Identifier
* @param pin pin code
* @param udid Device UDID
* @param secret Additional security parameter to validate the login
*/
public static LoginWithPinOttUserBuilder loginWithPin(int partnerId, String pin, String udid, String secret) {
return new LoginWithPinOttUserBuilder(partnerId, pin, udid, secret);
}
public static class LogoutOttUserBuilder extends RequestBuilder {
public LogoutOttUserBuilder() {
super(Boolean.class, "ottuser", "logout");
}
}
/**
* Logout the calling user.
*/
public static LogoutOttUserBuilder logout() {
return new LogoutOttUserBuilder();
}
public static class RefreshSessionOttUserBuilder extends RequestBuilder {
public RefreshSessionOttUserBuilder(String refreshToken, String udid) {
super(LoginSession.class, "ottuser", "refreshSession");
params.add("refreshToken", refreshToken);
params.add("udid", udid);
}
public void refreshToken(String multirequestToken) {
params.add("refreshToken", multirequestToken);
}
public void udid(String multirequestToken) {
params.add("udid", multirequestToken);
}
}
public static RefreshSessionOttUserBuilder refreshSession(String refreshToken) {
return refreshSession(refreshToken, null);
}
/**
* Returns new Kaltura session (ks) for the user, using the supplied refresh_token
(only if it's valid and not expired)
*
* @param refreshToken Refresh token
* @param udid Device UDID
*/
public static RefreshSessionOttUserBuilder refreshSession(String refreshToken, String udid) {
return new RefreshSessionOttUserBuilder(refreshToken, udid);
}
public static class RegisterOttUserBuilder extends RequestBuilder {
public RegisterOttUserBuilder(int partnerId, OTTUser user, String password) {
super(OTTUser.class, "ottuser", "register");
params.add("partnerId", partnerId);
params.add("user", user);
params.add("password", password);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void password(String multirequestToken) {
params.add("password", multirequestToken);
}
}
/**
* Sign up a new user.
*
* @param partnerId Partner identifier
* @param user The user model to add
* @param password password
*/
public static RegisterOttUserBuilder register(int partnerId, OTTUser user, String password) {
return new RegisterOttUserBuilder(partnerId, user, password);
}
public static class ResendActivationTokenOttUserBuilder extends RequestBuilder {
public ResendActivationTokenOttUserBuilder(int partnerId, String username) {
super(Boolean.class, "ottuser", "resendActivationToken");
params.add("partnerId", partnerId);
params.add("username", username);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void username(String multirequestToken) {
params.add("username", multirequestToken);
}
}
/**
* Resend the activation token to a user
*
* @param partnerId The partner ID
* @param username Username of the user to activate
*/
public static ResendActivationTokenOttUserBuilder resendActivationToken(int partnerId, String username) {
return new ResendActivationTokenOttUserBuilder(partnerId, username);
}
public static class ResetPasswordOttUserBuilder extends RequestBuilder {
public ResetPasswordOttUserBuilder(int partnerId, String username) {
super(Boolean.class, "ottuser", "resetPassword");
params.add("partnerId", partnerId);
params.add("username", username);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void username(String multirequestToken) {
params.add("username", multirequestToken);
}
}
/**
* Send an e-mail with URL to enable the user to set new password.
*
* @param partnerId Partner Identifier
* @param username user name
*/
public static ResetPasswordOttUserBuilder resetPassword(int partnerId, String username) {
return new ResetPasswordOttUserBuilder(partnerId, username);
}
public static class SetInitialPasswordOttUserBuilder extends RequestBuilder {
public SetInitialPasswordOttUserBuilder(int partnerId, String token, String password) {
super(OTTUser.class, "ottuser", "setInitialPassword");
params.add("partnerId", partnerId);
params.add("token", token);
params.add("password", password);
}
public void partnerId(String multirequestToken) {
params.add("partnerId", multirequestToken);
}
public void token(String multirequestToken) {
params.add("token", multirequestToken);
}
public void password(String multirequestToken) {
params.add("password", multirequestToken);
}
}
/**
* Renew the user's password after validating the token that sent as part
of URL in e-mail.
*
* @param partnerId Partner Identifier
* @param token Token that sent by e-mail
* @param password New password
*/
public static SetInitialPasswordOttUserBuilder setInitialPassword(int partnerId, String token, String password) {
return new SetInitialPasswordOttUserBuilder(partnerId, token, password);
}
public static class UpdateOttUserBuilder extends RequestBuilder {
public UpdateOttUserBuilder(OTTUser user) {
super(OTTUser.class, "ottuser", "update");
params.add("user", user);
}
}
/**
* Update user information
*
* @param user UserData Object (include basic and dynamic data)
*/
public static UpdateOttUserBuilder update(OTTUser user) {
return new UpdateOttUserBuilder(user);
}
public static class UpdateLoginDataOttUserBuilder extends RequestBuilder {
public UpdateLoginDataOttUserBuilder(String username, String oldPassword, String newPassword) {
super(Boolean.class, "ottuser", "updateLoginData");
params.add("username", username);
params.add("oldPassword", oldPassword);
params.add("newPassword", newPassword);
}
public void username(String multirequestToken) {
params.add("username", multirequestToken);
}
public void oldPassword(String multirequestToken) {
params.add("oldPassword", multirequestToken);
}
public void newPassword(String multirequestToken) {
params.add("newPassword", multirequestToken);
}
}
/**
* Given a user name and existing password, change to a new password.
*
* @param username user name
* @param oldPassword old password
* @param newPassword new password
*/
public static UpdateLoginDataOttUserBuilder updateLoginData(String username, String oldPassword, String newPassword) {
return new UpdateLoginDataOttUserBuilder(username, oldPassword, newPassword);
}
public static class UpdatePasswordOttUserBuilder extends NullRequestBuilder {
public UpdatePasswordOttUserBuilder(int userId, String password) {
super("ottuser", "updatePassword");
params.add("userId", userId);
params.add("password", password);
}
public void userId(String multirequestToken) {
params.add("userId", multirequestToken);
}
public void password(String multirequestToken) {
params.add("password", multirequestToken);
}
}
/**
* Update the user's existing password.
*
* @param userId User Identifier
* @param password new password
*/
public static UpdatePasswordOttUserBuilder updatePassword(int userId, String password) {
return new UpdatePasswordOttUserBuilder(userId, password);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy