/usr/include/sipxtapi/ptapi/PtTerminalCapabilities.h is in libsipxtapi-dev 3.3.0~test17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 | //
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _PtTerminalCapabilities_h_
#define _PtTerminalCapabilities_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsDefs.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class PtAddress;
class PtTerminal;
class PtConnection;
class PtTerminalConnection;
//:The TerminalCapabilities interface represents the initial capabilities interface for the Terminal.
// This interface supports basic queries for the core package.
// <p>
// Applications obtain the static Terminal capabilities via the Provider.getTerminalCapabilities()
// method, and the dynamic capabilities via the Terminal.getCapabilities() method. This interface
// is used to represent both static and dynamic capabilities.
// <p>
// Any package which extends the core Terminal interface should also extend this interface to
// provide additional capability queries for that particular package.
// <p>
class PtTerminalCapabilities
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/* ============================ CREATORS ================================== */
PtTerminalCapabilities();
//:Default constructor
PtTerminalCapabilities(const PtTerminalCapabilities& rPtTerminalCapabilities);
//:Copy constructor
virtual
~PtTerminalCapabilities();
//:Destructor
/* ============================ MANIPULATORS ============================== */
PtTerminalCapabilities& operator=(const PtTerminalCapabilities& rhs);
//:Assignment operator
/* ============================ ACCESSORS ================================= */
/* ============================ INQUIRY =================================== */
UtlBoolean isObservable();
//:Returns true if this terminal can be observed, false otherwise.
//!retcode: True if this terminal can be observed,
//!retcode: false otherwise.
UtlBoolean canGetDoNotDisturb();
//:Returns true if the application can obtain the do not disturb state, false otherwise.
//!retcode: True if the application can obtain the do not disturb state,
//!retcode: false otherwise.
UtlBoolean canSetDoNotDisturb();
//:Returns true if the application can set the do not disturb state, false otherwise.
//!retcode: True if the application can set the do not disturb state,
//!retcode: false otherwise.
UtlBoolean canPickup(PtConnection connection, PtAddress address);
//:Returns true if the application can invoke the overloaded pickup feature which takes a
// Connection and an Address as arguments, false otherwise.
// <p>
// The arguments provided are for typing purposes only. The particular instances of the
// objects given are ignored and not used to determine the capability outcome is any way.
//!param: connection - This argument is used for typing information to determine the overloaded version of the pickup() method.
//!param: address - This argument is used for typing information to determine the overloaded version of the pickup() method.
//!retcode: True if the application can invoke the pickup feature which takes a PtConnection and an PtAddress as arguments,
//!retcode: false otherwise.
UtlBoolean canPickup(PtTerminalConnection tc, PtAddress address);
//:Returns true if the application can invoke the overloaded pickup feature which takes a
// PtTerminalConnection and an PtAddress as arguments, false otherwise.
// <p>
// The arguments provided are for typing purposes only. The particular instances of the
// objects given are ignored and not used to determine the capability outcome is any way.
//!param: tc - This argument is used for typing information to determine the overloaded version of the pickup() method.
//!param: address - This argument is used for typing information to determine the overloaded version of the pickup() method.
//!retcode: True if the application can invoke the pickup feature which takes a TerminalConnection and an Address as arguments,
//!retcode: false otherwise.
UtlBoolean canPickup(PtAddress address1, PtAddress address2);
//:Returns true if the application can invoke the overloaded pickup feature which takes two
// Addresses as arguments, false otherwise.
// <p>
// The arguments provided are for typing purposes only. The particular instances of the
// objects given are ignored and not used to determine the capability outcome is any way.
//!param: address1 - This argument is used for typing information to determine the overloaded version of the pickup() method.
//!param: address2 - This argument is used for typing information to determine the overloaded version of the pickup() method.
//!retcode: True if the application can invoke the pickup feature which takes two Addresses as arguments,
//!retcode: false otherwise.
UtlBoolean canPickupFromGroup(UtlString group, PtAddress address);
//:Returns true if the application can invoke the pickup from group feature which takes a string
// pickup group code and an Address as arguments, false otherwise.
// <p>
// The arguments provided are for typing purposes only. The particular instances of the
// objects given are ignored and not used to determine the capability outcome is any way.
//!param: group - This argument is used for typing information to determine the overloaded version of the pickupFromGroup() method.
//!param: address - This argument is used for typing information to determine the overloaded version of the pickupFromGroup() method.
//!retcode: True if the application can invoke the pickup from group feature which takes a string pickup group code and an Address as arguments,
//!retcode: false otherwise.
UtlBoolean canPickupFromGroup(PtAddress address);
//:Returns true if the application can invoke the pickup from group feature which takes an
// Address as an argument, false otherwise.
// <p>
// The arguments provided are for typing purposes only. The particular instances of the
// objects given are ignored and not used to determine the capability outcome is any way.
//!param: address - This argument is used for typing information to determine the overloaded version of the pickupFromGroup() method.
//!retcode: True if the application can invoke the pickup from group feature which takes an Address as an argument,
//!retcode: false otherwise.
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
};
/* ============================ INLINE METHODS ============================ */
#endif // _PtTerminalCapabilities_h_
|