osfmk/UserNotification/UNDRequest.defs

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 subsystem
  30 #if KERNEL_USER
  31         KernelUser
  32 #endif /* KERNEL_USER */
  33         UNDRequest 6000;
  34
  35 #include <mach/std_types.defs>
  36 #include <UserNotification/UNDTypes.defs>
  37
  38
  39 /*
  40 --      Messages sent by the UserNotification Client to the Server
  41 */
  42
  43 /* Execution information */
  44 simpleroutine UNDExecute_rpc(
  45                                 server: UNDServerRef;
  46                         in      executionPath: UNDPath;
  47                         in      uid: int;
  48                         in      gid: int);
  49
  50 /* Bundle notice and bundle alert */
  51
  52 simpleroutine UNDDisplayNoticeFromBundle_rpc(
  53                                 server: UNDServerRef;
  54                         in      reply: UNDReplyRef;
  55                         in      bundlePath: UNDPath;
  56                         in      fileName: UNDPath;
  57                         in      fileExtension: UNDPath;
  58                         in      messageKey: UNDKey);
  59
  60 simpleroutine UNDDisplayAlertFromBundle_rpc(
  61                                 server: UNDServerRef;
  62                         in      reply: UNDReplyRef;
  63                         in      bundlePath: UNDPath;
  64                         in      fileName: UNDKey;
  65                         in      fileExtension: UNDKey;
  66                         in      messageKey: UNDKey);
  67
  68 simpleroutine UNDDisplayCustomFromBundle_rpc(
  69                                 server: UNDServerRef;
  70                         in      reply: UNDReplyRef;
  71                         in      bundlePath: UNDPath;
  72                         in      fileName: UNDKey;
  73                         in      fileExtension: UNDKey;
  74                         in      messageKey: UNDKey;
  75                         in      tokenKey: UNDPath);
  76
  77 simpleroutine UNDDisplayCustomFromDictionary_rpc(
  78                                 server: UNDServerRef;
  79                         in      reply: UNDReplyRef;
  80                         in      data: xmlData);
  81
  82 simpleroutine UNDCancelNotification_rpc(
  83                                 server: UNDServerRef;
  84                         in      userLandNotificationKey: int);
  85
  86 /*
  87  * Just pops up a notice with a single OK button and the label and message
  88  * specified below.  As such, there is no acknowledgement from the server.
  89  */
  90 simpleroutine UNDDisplayNoticeSimple_rpc(
  91                                 server: UNDServerRef;
  92                         in      rpctimeout: int;
  93                         in      flags: unsigned;
  94                         in      iconPath:UNDLabel;
  95                         in      soundPath:UNDLabel;
  96                         in      localizationPath:UNDLabel;
  97                         in      header: UNDLabel;
  98                         in      message: UNDMessage;
  99                         in      defaultButtonTitle:UNDLabel);
 100
 101 /*
 102  * A synchronous routine to display an alert.  This will wait for the
 103  * result to come back.  As this can take an exceedingly long time to
 104  * complete (and will block the calling thread for the duration) great
 105  * care should be exercised before using this method.
 106  */
 107 routine UNDDisplayAlertSimple_rpc(
 108                                 server: UNDServerRef;
 109                         in      rpctimeout: int;
 110                         in      flags: unsigned;
 111                         in      iconPath:UNDLabel;
 112                         in      soundPath:UNDLabel;
 113                         in      localizationPath:UNDLabel;
 114                         in      header: UNDLabel;
 115                         in      message: UNDMessage;
 116                         in      defaultButtonTitle:UNDLabel;
 117                         in      alternateButtonTitle:UNDLabel;
 118                         in      otherButtonTitle:UNDLabel;
 119                         out     response: int);