osfmk/UserNotification/UNDRequest.defs

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