com.kaltura.client.services.AdminUserService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kalturaApiClient Show documentation

KalturaClient is a library of Java classes that can be used to interact with the Kaltura REST API. More information about the REST API can be found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interect with the API. The current schema can be found at http://www.kaltura.com/api_v3/api_schema.php

There is a newer version: 19.3.0

Show newest version

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.types.AdminUser;
import com.kaltura.client.types.Authentication;
import com.kaltura.client.utils.request.NullRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

/**
 * This class was generated using generate.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

/**
 * Manage details for the administrative user
 * 
 * @param email 
 * @param password 
 * @param partnerId 
 * @param email 
 * @param hashKey 
 * @param newPassword new password to set
 * @param email 
 * @param password 
 * @param newEmail Optional, provide only when you want to update the email
 * @param newPassword 
 */
public class AdminUserService {
	
	public static class LoginAdminUserBuilder extends RequestBuilder {
		
		public LoginAdminUserBuilder(String email, String password, int partnerId) {
			super(String.class, "adminuser", "login");
			params.add("email", email);
			params.add("password", password);
			params.add("partnerId", partnerId);
		}
		
		public void email(String multirequestToken) {
			params.add("email", multirequestToken);
		}
		
		public void password(String multirequestToken) {
			params.add("password", multirequestToken);
		}
		
		public void partnerId(String multirequestToken) {
			params.add("partnerId", multirequestToken);
		}
	}

	public static LoginAdminUserBuilder login(String email, String password)  {
		return login(email, password, Integer.MIN_VALUE);
	}

	/**
	 * Get an admin session using admin email and password (Used for login to the KMC
	  application)
	 * 
	 * @param email 
	 * @param password 
	 * @param partnerId 
	 */
    public static LoginAdminUserBuilder login(String email, String password, int partnerId)  {
		return new LoginAdminUserBuilder(email, password, partnerId);
	}
	
	public static class ResetPasswordAdminUserBuilder extends NullRequestBuilder {
		
		public ResetPasswordAdminUserBuilder(String email) {
			super("adminuser", "resetPassword");
			params.add("email", email);
		}
		
		public void email(String multirequestToken) {
			params.add("email", multirequestToken);
		}
	}

	/**
	 * Reset admin user password and send it to the users email address
	 * 
	 * @param email 
	 */
    public static ResetPasswordAdminUserBuilder resetPassword(String email)  {
		return new ResetPasswordAdminUserBuilder(email);
	}
	
	public static class SetInitialPasswordAdminUserBuilder extends RequestBuilder {
		
		public SetInitialPasswordAdminUserBuilder(String hashKey, String newPassword) {
			super(Authentication.class, "adminuser", "setInitialPassword");
			params.add("hashKey", hashKey);
			params.add("newPassword", newPassword);
		}
		
		public void hashKey(String multirequestToken) {
			params.add("hashKey", multirequestToken);
		}
		
		public void newPassword(String multirequestToken) {
			params.add("newPassword", multirequestToken);
		}
	}

	/**
	 * Set initial users password
	 * 
	 * @param hashKey 
	 * @param newPassword new password to set
	 */
    public static SetInitialPasswordAdminUserBuilder setInitialPassword(String hashKey, String newPassword)  {
		return new SetInitialPasswordAdminUserBuilder(hashKey, newPassword);
	}
	
	public static class UpdatePasswordAdminUserBuilder extends RequestBuilder {
		
		public UpdatePasswordAdminUserBuilder(String email, String password, String newEmail, String newPassword) {
			super(AdminUser.class, "adminuser", "updatePassword");
			params.add("email", email);
			params.add("password", password);
			params.add("newEmail", newEmail);
			params.add("newPassword", newPassword);
		}
		
		public void email(String multirequestToken) {
			params.add("email", multirequestToken);
		}
		
		public void password(String multirequestToken) {
			params.add("password", multirequestToken);
		}
		
		public void newEmail(String multirequestToken) {
			params.add("newEmail", multirequestToken);
		}
		
		public void newPassword(String multirequestToken) {
			params.add("newPassword", multirequestToken);
		}
	}

	public static UpdatePasswordAdminUserBuilder updatePassword(String email, String password)  {
		return updatePassword(email, password, "");
	}

	public static UpdatePasswordAdminUserBuilder updatePassword(String email, String password, String newEmail)  {
		return updatePassword(email, password, newEmail, "");
	}

	/**
	 * Update admin user password and email
	 * 
	 * @param email 
	 * @param password 
	 * @param newEmail Optional, provide only when you want to update the email
	 * @param newPassword 
	 */
    public static UpdatePasswordAdminUserBuilder updatePassword(String email, String password, String newEmail, String newPassword)  {
		return new UpdatePasswordAdminUserBuilder(email, password, newEmail, newPassword);
	}
}