osfmk/UserNotification/UNDRequest.defs

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