osfmk/UserNotification/UNDRequest.defs

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