Constants.php

<?php
/*
 * This file is a part of Wurrd ClientInterface Plugin.
 *
 * Copyright 2015 Eyong N <eyongn@scalior.com>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file Constants used by the Wurrd:ClientInterface plugin.
 */

namespace Wurrd\Mibew\Plugin\ClientInterface;

/**
 * Constants
 */
class Constants
{
	// Version and installation informatiom    
    const WCI_VERSION 				= '1.0.6';
	const WCI_API_VERSION			= '1006';
	const WCI_CONFIG_PREFIX			= 'wurrd_ci_';
	const WCI_VERSION_KEY			= 'wurrd_ci_version';
	const WCI_INSTALLATION_ID_KEY	= 'wurrd_ci_installation_id';
	const WCI_API_VERSION_KEY		= 'wurrd_ci_api_version';
	const SUPPORTED_MIBEW_PROTOCOL	= '1.0';
		
	// API response messages
	const MSG_SUCCESS			 		= 'Success';
	const MSG_UNKNOWN_ERROR				= 'UnknownError';
	const MSG_INVALID_ACCESS_TOKEN 		= 'InvalidAccessToken';
	const MSG_EXPIRED_ACCESS_TOKEN 		= 'ExpiredAccessToken';
	const MSG_INVALID_REFRESH_TOKEN 	= 'InvalidRefreshToken';
	const MSG_EXPIRED_REFRESH_TOKEN 	= 'ExpiredRefreshToken';
	const MSG_INVALID_OPERATOR			= 'InvalidOperator';
	const MSG_INVALID_DEVICE			= 'InvalidDevice';
	const MSG_INVALID_JSON				= 'InvalidJSON';
	const MSG_INVALID_CLIENTID			= 'InvalidClientID';
	const MSG_WRONG_TRHEAD				= 'WrongThread';
	const MSG_CANNOT_TAKEOVER			= 'CannotTakeover';
	const MSG_CANNOT_TAKE_THREAD		= 'CannotTakeThread';
	const MSG_CANNOT_VIEW_THREADS		= 'CannotViewThreads';
	const MSG_CONFIRM_TAKEOVER			= 'ConfirmTakeover';
	const MSG_ASSET_NOT_FOUND			= 'AssetNotFound';
	
	// Constants for keys used to request access
	const CLIENTID_KEY 			= 'clientid';
	const USERNAME_KEY 			= 'username';
	const PASSWORD_KEY 			= 'password';
	const DEVICEUUID_KEY 		= 'deviceuuid';
	const PLATFORM_KEY 			= 'platform';
	const TYPE_KEY 				= 'type';
	const DEVICENAME_KEY 		= 'devicename';
	const ACCESSTOKEN_KEY		= 'accesstoken';
	const CLIENTAPIVER_KEY		= 'clientapiver';
	const CLIENTREVISION_KEY	= 'clientrevision';
		
    /**
     * This class should not be instantiated
     */
    private function __construct()
    {
    }
}