/*
 * Copyright (c) 2010-2022 Belledonne Communications SARL.
 *
 * This file is part of Liblinphone 
 * (see https://gitlab.linphone.org/BC/public/liblinphone).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _MSC_VER
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif // _MSC_VER

#ifndef _EVENT_HH
#define _EVENT_HH

#include <string>
#include "enums.hh"
#include "object.hh"




struct _LinphoneEvent;


namespace linphone {

	class Core;
	class ErrorInfo;
	class Address;
	class Content;
	class EventListener;

	/**
	 * @brief Object representing an event state, which is subcribed or published. 
	 *
	 * @see Core::publish() 
	 * @see Core::subscribe() 
	 */
	class Event: public MultiListenableObject {
	
		public:

			LINPHONECXX_PUBLIC Event(void *ptr, bool takeRef=true);
			LINPHONECXX_PUBLIC _LinphoneEvent *cPtr() {return (_LinphoneEvent *)mPrivPtr;}

			/**
			 * @brief Add an application listener to the Event instance.
			 *
			 * @param listener the application listener
			 */
			LINPHONECXX_PUBLIC void addListener(const std::shared_ptr<EventListener> &listener);
			/**
			 * @brief Remove a previously added listener from the Event instance.
			 *
			 * @param listener the application listener
			 */
			LINPHONECXX_PUBLIC void removeListener(const std::shared_ptr<EventListener> &listener);
	
		public:
			
		
			/**
			 * @brief Get the call ID of the subscription. 
			 *
			 * @return The call ID used by the call as a string.    
			 */
			LINPHONECXX_PUBLIC std::string getCallId() const;
			
			/**
			 * @brief Returns back pointer to the @ref Core that created this @ref Event. 
			 *
			 * @return the @ref Core object associated.    
			 */
			LINPHONECXX_PUBLIC std::shared_ptr<linphone::Core> getCore() const;
			
			/**
			 * @brief Get full details about an error occured. 
			 *
			 * @return a @ref ErrorInfo object.    
			 */
			LINPHONECXX_PUBLIC std::shared_ptr<const linphone::ErrorInfo> getErrorInfo() const;
			
			/**
			 * @brief Get the "from" address of the subscription. 
			 *
			 * @return the from @ref Address.    
			 * @deprecated 19/07/2020 use getFromAddress() instead 
			 */
			LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::shared_ptr<const linphone::Address> getFrom() const;
			
			/**
			 * @brief Get the "from" address of the subscription. 
			 *
			 * @return the from @ref Address.    
			 */
			LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> getFromAddress() const;
			
			/**
			 * @brief Get the name of the event as specified in the event package RFC. 
			 *
			 * @return the event name.    
			 */
			LINPHONECXX_PUBLIC std::string getName() const;
			
			/**
			 * @brief Get publish state. 
			 *
			 * If the event object was not created by a publish mechanism, @ref
			 * PublishState::None is returned. 
			 * @return the current @ref PublishState 
			 */
			LINPHONECXX_PUBLIC linphone::PublishState getPublishState() const;
			
			/**
			 * @brief Return reason code (in case of error state reached). 
			 *
			 * @return a @ref Reason enum 
			 */
			LINPHONECXX_PUBLIC linphone::Reason getReason() const;
			
			/**
			 * @brief Get the "contact" address of the subscription. 
			 *
			 * @return The "contact" address of the subscription    
			 */
			LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> getRemoteContact() const;
			
			/**
			 * @brief Get the "request uri" address of the subscription. 
			 *
			 * @return the request uri @ref Address.    
			 */
			LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> getRequestAddress() const;
			
			/**
			 * @brief Sets the "request uri" address of the subscription. 
			 *
			 * @param requestAddress @ref Address to use in the request uri    
			 */
			LINPHONECXX_PUBLIC void setRequestAddress(const std::shared_ptr<linphone::Address> & requestAddress);
			
			/**
			 * @brief Get the resource address of the subscription or publish. 
			 *
			 * @return the resource @ref Address.    
			 */
			LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> getResource() const;
			
			/**
			 * @brief Get subscription direction. 
			 *
			 * If the object wasn't created by a subscription mechanism, @ref
			 * SubscriptionDir::InvalidDir is returned. 
			 * @return the @ref SubscriptionDir 
			 */
			LINPHONECXX_PUBLIC linphone::SubscriptionDir getSubscriptionDir();
			
			/**
			 * @brief Get subscription state. 
			 *
			 * If the event object was not created by a subscription mechanism, @ref
			 * SubscriptionState::None is returned. 
			 * @return the current @ref SubscriptionState 
			 */
			LINPHONECXX_PUBLIC linphone::SubscriptionState getSubscriptionState() const;
			
			/**
			 * @brief Get the "to" address of the subscription. 
			 *
			 * @return the to @ref Address.    
			 * @deprecated 19/07/2020 use getToAddress() instead 
			 */
			LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::shared_ptr<const linphone::Address> getTo() const;
			
			/**
			 * @brief Get the "to" address of the subscription. 
			 *
			 * @return the to @ref Address.    
			 */
			LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> getToAddress() const;
			
			/**
			 * @brief Accept an incoming publish. 
			 *
			 * @return 0 if successful, error code otherwise 
			 */
			LINPHONECXX_PUBLIC linphone::Status acceptPublish();
			
			/**
			 * @brief Accept an incoming subcription. 
			 *
			 * @return 0 if successful, error code otherwise 
			 */
			LINPHONECXX_PUBLIC linphone::Status acceptSubscription();
			
			/**
			 * @brief Add a custom header to an outgoing susbscription or publish. 
			 *
			 * @param name header's name    
			 * @param value the header's value.    
			 */
			LINPHONECXX_PUBLIC void addCustomHeader(const std::string & name, const std::string & value);
			
			/**
			 * @brief Deny an incoming publish with given reason. 
			 *
			 * @param reason The @ref Reason of denial.    
			 * @return 0 if successful, error code otherwise 
			 */
			LINPHONECXX_PUBLIC linphone::Status denyPublish(linphone::Reason reason);
			
			/**
			 * @brief Deny an incoming subscription with given reason. 
			 *
			 * @param reason The @ref Reason of denial.    
			 * @return 0 if successful, error code otherwise 
			 */
			LINPHONECXX_PUBLIC linphone::Status denySubscription(linphone::Reason reason);
			
			/**
			 * @brief Obtain the value of a given header for an incoming subscription. 
			 *
			 * @param name header's name    
			 * @return the header's value or nullptr if such header doesn't exist.    
			 */
			LINPHONECXX_PUBLIC std::string getCustomHeader(const std::string & name);
			
			/**
			 * @brief Send a notification. 
			 *
			 * @param body an optional body containing the actual notification data.   
			 * @return 0 if successful, -1 otherwise. 
			 */
			LINPHONECXX_PUBLIC linphone::Status notify(const std::shared_ptr<const linphone::Content> & body);
			
			/**
			 * @brief Prevent an event from refreshing its publish. 
			 *
			 * This is useful to let registrations to expire naturally (or) when the
			 * application wants to keep control on when refreshes are sent. The refreshing
			 * operations can be resumed with ProxyConfig::refreshRegister(). 
			 */
			LINPHONECXX_PUBLIC void pausePublish();
			
			/**
			 * @brief Refresh an outgoing publish keeping the same body. 
			 *
			 * @return 0 if successful, -1 otherwise. 
			 */
			LINPHONECXX_PUBLIC linphone::Status refreshPublish();
			
			/**
			 * @brief Refresh an outgoing subscription keeping the same body. 
			 *
			 * @return 0 if successful, -1 otherwise. 
			 */
			LINPHONECXX_PUBLIC linphone::Status refreshSubscribe();
			
			/**
			 * @brief Remove custom header to an outgoing susbscription or publish. 
			 *
			 * @param name header's name    
			 */
			LINPHONECXX_PUBLIC void removeCustomHeader(const std::string & name);
			
			/**
			 * @brief Send a publish created by Core::createPublish(). 
			 *
			 * @param body the new data to be published    
			 * @return 0 if successful, -1 otherwise. 
			 */
			LINPHONECXX_PUBLIC linphone::Status sendPublish(const std::shared_ptr<const linphone::Content> & body);
			
			/**
			 * @brief Send a subscription previously created by Core::createSubscribe(). 
			 *
			 * @param body optional content to attach with the subscription.    
			 * @return 0 if successful, -1 otherwise. 
			 */
			LINPHONECXX_PUBLIC linphone::Status sendSubscribe(const std::shared_ptr<const linphone::Content> & body);
			
			/**
			 * @brief Terminate an incoming or outgoing subscription that was previously
			 * acccepted, or a previous publication. 
			 *
			 * The @ref Event shall not be used anymore after this operation. 
			 */
			LINPHONECXX_PUBLIC void terminate();
			
			/**
			 * @brief Update (refresh) a publish. 
			 *
			 * @param body the new data to be published    
			 * @return 0 if successful, error code otherwise 
			 */
			LINPHONECXX_PUBLIC linphone::Status updatePublish(const std::shared_ptr<const linphone::Content> & body);
			
			/**
			 * @brief Update (refresh) an outgoing subscription, changing the body. 
			 *
			 * @param body an optional body to include in the subscription update, may be
			 * nullptr.    
			 * @return 0 if successful, error code otherwise    
			 */
			LINPHONECXX_PUBLIC linphone::Status updateSubscribe(const std::shared_ptr<const linphone::Content> & body);
			
			
		private:
			void *createCallbacks() override;
	};

};

#endif // _EVENT_HH

#ifndef _MSC_VER
#pragma GCC diagnostic pop
#endif // _MSC_VER
