forked from blackberry/WebWorks-API-Docs
/
blackberry_identity.js
126 lines (116 loc) · 3.34 KB
/
blackberry_identity.js
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
/*
* Copyright 2010-2011 Research In Motion Limited.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @toc {Identity} Identity
* @BB50+
* @RIPPLE
* @namespace The Identity object contains information regarding the user's identity and accounts on a BlackBerry smartphone.
* @featureID blackberry.identity
* @featureID blackberry.identity.phone
* @permission read_device_identifying_information Permits your app to access device identifiers.
*/
blackberry.identity = {
/**
* Returns a JSON object containing the PIN of the device.
* @uri
* @PB10+
* @returns {JSON of all the properties}
* {
* "data":{
* "PIN":"0x12345678",
* }
* }
* @example
* <html>
* <head>
* <script type="text/javascript" src="js/jquery-1.4.2.js" ></script>
* <script type="text/javascript" src="js/jquery.form.js" ></script>
* <script type="text/javascript" src="js/jquery.populate.js" ></script>
*
* <script type="text/javascript">
* function getIdentityData(){
* $.ajax({
* type: "get",
* url: "http://localhost:8472/blackberry/identity/get",
* success: function(msg){
* $('#myIdentityDiv').populate(JSON.parse(msg).data);
* }
* });
* }
* </script>
*
*</head>
*<body>
*
* <input type="button" onclick="getIdentityData();" value="Populate - IDENTITY"/>
* <div id="myIdentityDiv">
* PIN: <span id="PIN"></span><br/>
* </div>
*
*</body>
*</html>
*/
get: function(){}
};
/**
* Returns the list of Service objects that describe each of the services that the user has for their device.
* @returns {Service[]}
* @BB50+
* @RIPPLE
*/
blackberry.identity.getServiceList = function() { };
/**
* Returns a list of possible communications transports that can be used.
* @returns {Transport[]}
* @BB50+
* @RIPPLE
* @example
* <script type="text/javascript">
* var transportList = blackberry.identity.getTransportList();
* for (var i = 0; i < transportList.length; i++) {
* alert("Transport name is:" + transportList[i].name + "\ntransport type:" + transportList[i].type);
* }
* </script>
*/
blackberry.identity.getTransportList = function() { };
/**
* Contains the Personal Identification number for the smartphone.
* @type String
* @static
* @readOnly
* @BB50+
* @RIPPLE
* @PB10+
*/
blackberry.identity.PIN = { };
/**
* Contains the IMSI number for the smartphone.
* @type String
* @static
* @readOnly
* @BB50+
* @RIPPLE
*/
blackberry.identity.IMSI = { };
/**
* Contains the IMEI number for the smartphone.
* @type String
* @static
* @readOnly
* @BB50+
* @RIPPLE
*/
blackberry.identity.IMEI = { };