//  SDLResult.h
//


#import "SDLEnum.h"

/**
 * Defines the possible result codes returned by SDL to the application in a response to a requested operation
 *
 * @since SDL 1.0
 */
typedef SDLEnum SDLResult SDL_SWIFT_ENUM;

/**
 * @abstract The request succeeded
 */
extern SDLResult const SDLResultSuccess;

/**
 * @abstract Result code : Invalid Data
 *
 * @discussion The data sent is invalid. For example:
 * <li>Invalid Json syntax</li>
 * <li>Parameters out of bounds (number or enum range)</li>
 * <li>Mandatory parameters not provided</li>
 * <li>Parameter provided with wrong type</li>
 * <li>Invalid characters</li>
 * <li>Empty string</li>
 */
extern SDLResult const SDLResultInvalidData;

extern SDLResult const SDLResultCharacterLimitExceeded;

/**
 * @abstract The request is not supported by SDL
 */
extern SDLResult const SDLResultUnsupportedRequest;

/**
 * @abstract The system could not process the request because the necessary memory couldn't be allocated
 */
extern SDLResult const SDLResultOutOfMemory;

/**
 * @abstract There are too many requests pending (means that the response has not been delivered yet).
 *
 * @discussion There is a limit of 1000 pending requests at a time.
 */
extern SDLResult const SDLResultTooManyPendingRequests;

/**
 * @abstract One of the provided IDs is not valid.
 * @discussion For example:
 * <li>CorrelationID</li>
 * <li>CommandID</li>
 * <li>MenuID</li>
 */
extern SDLResult const SDLResultInvalidId;

/**
 * @abstract The provided name or synonym is a duplicate of some already-defined name or synonym.
 */
extern SDLResult const SDLResultDuplicateName;

/**
 * There are already too many registered applications.
 */
extern SDLResult const SDLResultTooManyApplications;

/**
 * RegisterApplication has been called again, after a RegisterApplication was successful before.
 */
extern SDLResult const SDLResultApplicationRegisteredAlready;

/**
 * The Head Unit doesn't support the protocol that is requested by the mobile application.
 */
extern SDLResult const SDLResultUnsupportedVersion;

/**
 * The requested language is currently not supported. Might be because of a mismatch of the currently active language on the head unit and the requested language.
 */
extern SDLResult const SDLResultWrongLanguage;

/**
 * A command can not be executed because no application has been registered with RegisterApplication.
 */
extern SDLResult const SDLResultApplicationNotRegistered;

/**
 * The data may not be changed, because it is currently in use. For example when trying to delete a command set that is currently involved in an interaction.
 */
extern SDLResult const SDLResultInUse;

/**
 * The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.
 */
extern SDLResult const SDLResultVehicleDataNotAllowed;

/**
 * The requested vehicle data is not available on this vehicle or is not published.
 */
extern SDLResult const SDLResultVehicleDataNotAvailable;

/**
 * The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.
 */
extern SDLResult const SDLResultRejected;

/**
 * A command was aborted, for example due to user interaction (e.g. user pressed button). Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.
 */
extern SDLResult const SDLResultAborted;

/**
 * A command was ignored, because the intended result is already in effect. For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already.
 */
extern SDLResult const SDLResultIgnored;

/**
 *  A button that was requested for subscription is not supported under the current system.
 */
extern SDLResult const SDLResultUnsupportedResource;

/**
 * A specified file could not be found on the head unit.
 */
extern SDLResult const SDLResultFileNotFound;

/**
 * Provided data is valid but something went wrong in the lower layers.
 */
extern SDLResult const SDLResultGenericError;

/**
 * RPC is not authorized in local policy table.
 */
extern SDLResult const SDLResultDisallowed;

/**
 * RPC is included in a functional group explicitly blocked by the user.
 */
extern SDLResult const SDLResultUserDisallowed;

/**
 * Overlay reached the maximum timeout and closed.
 */
extern SDLResult const SDLResultTimedOut;

/**
 * User selected to Cancel Route.
 */
extern SDLResult const SDLResultCancelRoute;

/**
 * The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.
 */
extern SDLResult const SDLResultTruncatedData;
/**
 * The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.
 */
extern SDLResult const SDLResultRetry;

/**
 * The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.
 */
extern SDLResult const SDLResultWarnings;

/**
 * The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.
 */
extern SDLResult const SDLResultSaved;

/**
 * The certificate provided during authentication is invalid.
 */
extern SDLResult const SDLResultInvalidCertificate;

/**
 * The certificate provided during authentication is expired.
 */
extern SDLResult const SDLResultExpiredCertificate;

/**
 * The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.
 */
extern SDLResult const SDLResultResumeFailed;