hti/PC_Tools/HTIGateway/ServicePlugins/HtiMessages/HtiMessages.h
branchRCL_3
changeset 19 07b41fa8d1dd
parent 18 3406c99bc375
child 20 ca8a1b6995f6
equal deleted inserted replaced
18:3406c99bc375 19:07b41fa8d1dd
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 * 
       
    14 * Description:
       
    15 */
       
    16 // HTI service functions
       
    17 //gsoap ns1 service name: HtiMessages
       
    18 //gsoap ns1 service namespace: urn:hti
       
    19 //gsoap ns1 service style: rpc
       
    20 //gsoap ns1 service encoding: literal
       
    21 //gsoap ns1 service location: http://localhost:2000
       
    22 
       
    23 typedef int             xsd__int;
       
    24 typedef char*           xsd__string;
       
    25 typedef bool            xsd__boolean;
       
    26 typedef unsigned char   xsd__unsignedByte;
       
    27 typedef unsigned short  xsd__unsignedShort;
       
    28 
       
    29 enum ns1__folder      { AllFolders, Indox, Drafts, Sent, Outbox };
       
    30 enum ns1__messageType { AllMessages, SMS, MMS, SmartMsg, Email, IRmsg, BTmsg, AudioMsg };
       
    31 
       
    32 enum ns1__bearerType      { CSD = 1, GPRS = 2, HSCSD = 4, CDMA = 16, WLAN = 32 };
       
    33 enum ns1__mailboxType     { POP3, IMAP4 };
       
    34 enum ns1__securitySetting { Off, TLS, SSL };
       
    35 enum ns1__sendOption      { Immediately, NextConnection, OnRequest };
       
    36 enum ns1__copyToOwn       { NoCopy, ToField, CcField, BccField };
       
    37 enum ns1__retrievedParts  { OnlyHeaders, LessThanSize, BodyAndAttachments };
       
    38 enum ns1__automaticUpdate { AlwaysOn, InHomeNetwork, NotEnabled };
       
    39 
       
    40 enum ns1__mmsCreationMode { Restricted, Guided, Free };
       
    41 enum ns1__mmsImageSize    { Small, Large, Original };
       
    42 enum ns1__mmsReception    { AlwaysAutomatic, AutomaticInHomeNetwork,
       
    43                             AlwaysManual, Disabled };
       
    44 enum ns1__msgValidity     { Maximum, OneHour, SixHours, TwentyFourHours,
       
    45 							ThreeDays, OneWeek };
       
    46 
       
    47 enum ns1__smsCharacterSupport    { Full, Reduced };
       
    48 enum ns1__smsMessageConversion   { None, Fax, Paging, EMail };
       
    49 enum ns1__smsPreferredConnection { GSM, PacketData };
       
    50 
       
    51 struct ns1__HtiAPSettingField
       
    52 {
       
    53     xsd__unsignedByte    fieldType;
       
    54     xsd__string          fieldData;
       
    55 };
       
    56 
       
    57 struct ArrayOfHtiAPSettingFields
       
    58 {
       
    59     struct ns1__HtiAPSettingField* __ptrHtiAPSettingField;
       
    60     int __size;
       
    61 };
       
    62 
       
    63 
       
    64 //gsoap ns1 service method-action: addSMS "HtiMessages"
       
    65 int ns1__addSMS(
       
    66     xsd__string      fromField,
       
    67     xsd__string      description,
       
    68     xsd__string      messageBody,
       
    69     xsd__boolean     isNewFlag,
       
    70     xsd__boolean     isUnreadFlag,
       
    71     enum ns1__folder folder,
       
    72     xsd__int         &messageId
       
    73 );
       
    74 
       
    75 //gsoap ns1 service method-action: addMMS "HtiMessages"
       
    76 int ns1__addMMS(
       
    77     xsd__string      fromField,
       
    78     xsd__string      description,
       
    79     xsd__string      messageBody,
       
    80     xsd__string      attachmentPath,
       
    81     xsd__boolean     isNewFlag,
       
    82     xsd__boolean     isUnreadFlag,
       
    83     enum ns1__folder folder,
       
    84     xsd__int         &messageId
       
    85 );
       
    86 
       
    87 //gsoap ns1 service method-action: addEMail "HtiMessages"
       
    88 int ns1__addEMail(
       
    89     xsd__string      fromField,
       
    90     xsd__string      description,
       
    91     xsd__string      messageBody,
       
    92     xsd__string      attachmentPath,
       
    93     xsd__boolean     isNewFlag,
       
    94     xsd__boolean     isUnreadFlag,
       
    95     enum ns1__folder folder,
       
    96     xsd__int         &messageId
       
    97 );
       
    98 
       
    99 //gsoap ns1 service method-action: addIRMessage "HtiMessages"
       
   100 int ns1__addIRMessage(
       
   101     xsd__string      fromField,
       
   102     xsd__string      description,
       
   103     xsd__string      attachmentPath,
       
   104     xsd__boolean     isNewFlag,
       
   105     xsd__boolean     isUnreadFlag,
       
   106     enum ns1__folder folder,
       
   107     xsd__int         &messageId
       
   108 );
       
   109 
       
   110 //gsoap ns1 service method-action: addBTMessage "HtiMessages"
       
   111 int ns1__addBTMessage(
       
   112     xsd__string      fromField,
       
   113     xsd__string      description,
       
   114     xsd__string      attachmentPath,
       
   115     xsd__boolean     isNewFlag,
       
   116     xsd__boolean     isUnreadFlag,
       
   117     enum ns1__folder folder,
       
   118     xsd__int         &messageId
       
   119 );
       
   120 
       
   121 //gsoap ns1 service method-action: addSmartMessage "HtiMessages"
       
   122 int ns1__addSmartMessage(
       
   123     xsd__string      fromField,
       
   124     xsd__string      description,
       
   125     xsd__string      messageBody,
       
   126     xsd__boolean     isNewFlag,
       
   127     xsd__boolean     isUnreadFlag,
       
   128     enum ns1__folder folder,
       
   129     xsd__int         BIOmessageUID,
       
   130     xsd__int         &messageId
       
   131 );
       
   132 
       
   133 //gsoap ns1 service method-action: addAudioMessage "HtiMessages"
       
   134 int ns1__addAudioMessage(
       
   135     xsd__string      fromField,
       
   136     xsd__string      description,
       
   137     xsd__string      attachmentPath,
       
   138     xsd__boolean     isNewFlag,
       
   139     xsd__boolean     isUnreadFlag,
       
   140     enum ns1__folder folder,
       
   141     xsd__int         &messageId
       
   142 );
       
   143 
       
   144 //gsoap ns1 service method-action: deleteMessage "HtiMessages"
       
   145 int ns1__deleteMessage(
       
   146     xsd__int         messageId,
       
   147     struct ns1__deleteMessageResponse{} *out  // empty response
       
   148 );
       
   149 
       
   150 //gsoap ns1 service method-action: deleteAllFromFolder "HtiMessages"
       
   151 int ns1__deleteAllFromFolder(
       
   152     enum ns1__messageType    type,
       
   153     enum ns1__folder         folder,
       
   154     struct ns1__deleteAllFromFolderResponse{} *out  // empty response
       
   155 );
       
   156 
       
   157 //gsoap ns1 service method-action: createAccessPoint "HtiMessages"
       
   158 int ns1__createAccessPoint(
       
   159     enum ns1__bearerType    bearer,
       
   160     xsd__string             apName,
       
   161     struct ArrayOfHtiAPSettingFields    APSettings,
       
   162     xsd__int                            &apId
       
   163 );
       
   164 
       
   165 //gsoap ns1 service method-action: deleteAccessPoint "HtiMessages"
       
   166 int ns1__deleteAccessPoint(
       
   167     xsd__string apName,
       
   168     struct ns1__deleteAccessPointResponse{} *out  //empty response
       
   169 );
       
   170 
       
   171 //gsoap ns1 service method-action: createMailbox "HtiMessages"
       
   172 int ns1__createMailbox(
       
   173     enum ns1__mailboxType mailboxType,
       
   174     xsd__string mailboxName,
       
   175     xsd__string incomingServer,
       
   176     xsd__string incomingAccessPoint,
       
   177     xsd__string incomingUsername,
       
   178     xsd__string incomingPassword,
       
   179     enum ns1__securitySetting incomingSecurity,
       
   180     xsd__unsignedShort incomingPort,
       
   181     xsd__boolean aPopSecureLogin,
       
   182     xsd__string outgoingServer,
       
   183     xsd__string outgoingAccessPoint,
       
   184     xsd__string outgoingUsername,
       
   185     xsd__string outgoingPassword,
       
   186     enum ns1__securitySetting outgoingSecurity,
       
   187     xsd__unsignedShort outgoingPort,
       
   188     xsd__string ownMailAddress,
       
   189     xsd__string ownName,
       
   190     enum ns1__sendOption sendOption,
       
   191     enum ns1__copyToOwn copyToOwnAddress,
       
   192     xsd__string signatureText,
       
   193     xsd__boolean newMailIndicators,
       
   194     enum ns1__retrievedParts retrievedParts,
       
   195     xsd__unsignedShort retrieveSizeLimit,
       
   196     xsd__unsignedShort emailsToRetrieve,
       
   197     xsd__string imap4FolderPath,
       
   198     enum ns1__automaticUpdate automaticUpdate,
       
   199     xsd__boolean setAsDefault,
       
   200     struct ns1__createMailboxResponse{} *out  //empty response
       
   201 );
       
   202 
       
   203 //gsoap ns1 service method-action: deleteMailbox "HtiMessages"
       
   204 int ns1__deleteMailbox(
       
   205     xsd__string mailboxName,
       
   206     struct ns1__deleteMailboxResponse{} *out  //empty response
       
   207 );
       
   208 
       
   209 //gsoap ns1 service method-action: setDefaultSmsCenter "HtiMessages"
       
   210 int ns1__setDefaultSmsCenter(
       
   211     xsd__string smsCenterName,
       
   212     xsd__string smsCenterNumber,
       
   213     struct ns1__setDefaultSmsCenterResponse{} *out  //empty response
       
   214 );
       
   215 
       
   216 //gsoap ns1 service method-action: deleteSmsCenter "HtiMessages"
       
   217 int ns1__deleteSmsCenter(
       
   218     xsd__string smsCenterName,
       
   219     struct ns1__deleteSmsCenterResponse{} *out  //empty response
       
   220 );
       
   221 
       
   222 //gsoap ns1 service method-action: setSmsSettings "HtiMessages"
       
   223 int ns1__setSmsSettings(
       
   224     enum ns1__smsCharacterSupport characterSupport,
       
   225     xsd__boolean requestDeliveryReport,
       
   226     enum ns1__msgValidity validityPeriod,
       
   227     enum ns1__smsMessageConversion messageConversion,
       
   228     enum ns1__smsPreferredConnection preferredConnection,
       
   229     xsd__boolean replyViaSameCenter,
       
   230     struct ns1__setSmsSettingsResponse{} *out  //empty response
       
   231 );
       
   232 
       
   233 //gsoap ns1 service method-action: setMmsSettings "HtiMessages"
       
   234 int ns1__setMmsSettings(
       
   235 	xsd__string accessPointName,
       
   236     enum ns1__mmsCreationMode creationMode,
       
   237     enum ns1__mmsImageSize imageSize,
       
   238     enum ns1__mmsReception reception,
       
   239     xsd__boolean receiveAnonymous,
       
   240     xsd__boolean receiveAdvertisements,
       
   241     xsd__boolean requestDeliveryReports,
       
   242     xsd__boolean sendDeliveryReports,
       
   243     enum ns1__msgValidity validityPeriod,
       
   244     struct ns1__setMmsSettingsResponse{} *out  //empty response
       
   245 );
       
   246 
       
   247 //gsoap ns1 service method-action: createDestination "HtiMessages"
       
   248 int ns1__createDestination(
       
   249     xsd__string destinationName,
       
   250     struct ns1__createDestinationResponse{} *out //empty response
       
   251 );
       
   252 
       
   253 //gsoap ns1 service method-action: deleteDestination "HtiMessages"
       
   254 int ns1__deleteDestination(
       
   255     xsd__string destinationName,
       
   256     struct ns1__deleteDestinationResponse{} *out //empty response
       
   257 );
       
   258 
       
   259 //gsoap ns1 service method-action: addToDestination "HtiMessages"
       
   260 int ns1__addToDestination(
       
   261     xsd__string accessPointName,
       
   262     xsd__string destinationName,
       
   263     struct ns1__addToDestinationResponse{} *out //empty response
       
   264 );
       
   265 
       
   266 //gsoap ns1 service method-action: removeFromDestination "HtiMessages"
       
   267 int ns1__removeFromDestination(
       
   268     xsd__string accessPointName,
       
   269     xsd__string destinationName,
       
   270     struct ns1__removeFromDestinationResponse{} *out //empty response
       
   271 );