~tiagosh/telepathy-qt/group-chat2

<div class="title">Tp::Client::ChannelInterfaceGroupInterface Class Reference<div class="ingroups"><a class="el" href="a00739.html">Channel proxies</a></div></div> </div>

</div>

<p><code>#include <<a class="el" href="a00502_source.html">TelepathyQt/Channel</a>></code></p>

<p>Inherits <a class="el" href="a00037.html">Tp::AbstractInterface</a>.</p>

<p><a href="a01090.html">List of all members.</a></p>

Public Slots</h2>

<ul>

<li>QDBusPendingReply <a class="el" href="a00126.html#a679717c703b0c51ebc9dc1ff6a248693">AddMembers</a> (const <a class="el" href="a00414.html">Tp::UIntList</a> &contacts, const QString &message, int timeout=-1)

<li>QDBusPendingReply<br class="typebreak"/>

< <a class="el" href="a00414.html">Tp::UIntList</a>, <a class="el" href="a00414.html">Tp::UIntList</a>, <br class="typebreak"/>

<a class="el" href="a00414.html">Tp::UIntList</a> > <a class="el" href="a00126.html#ac801b6c6f0174090f556d4451fd94fd7">GetAllMembers</a> (int timeout=-1)

<li>QDBusPendingReply< uint > <a class="el" href="a00126.html#ad307d230353b15975e824b9becee2bf0">GetGroupFlags</a> (int timeout=-1)

<li>QDBusPendingReply< <a class="el" href="a00414.html">Tp::UIntList</a> > <a class="el" href="a00126.html#ae124118f5339d05e033018c1d540b9b9">GetHandleOwners</a> (const <a class="el" href="a00414.html">Tp::UIntList</a> &handles, int timeout=-1)

<li>QDBusPendingReply< <a class="el" href="a00414.html">Tp::UIntList</a> > <a class="el" href="a00126.html#a71a77339bd0c81193ef4ab7501495e20">GetLocalPendingMembers</a> (int timeout=-1)

<li>QDBusPendingReply<br class="typebreak"/>

< <a class="el" href="a00761.html#gac97059fe5c133488d4dcfec37f43df7b">Tp::LocalPendingInfoList</a> > <a class="el" href="a00126.html#a672af560e2335b00a096b69702c2cdde">GetLocalPendingMembersWithInfo</a> (int timeout=-1)

<li>QDBusPendingReply< <a class="el" href="a00414.html">Tp::UIntList</a> > <a class="el" href="a00126.html#a002272a6c67ee7682f32cd318b3d7058">GetMembers</a> (int timeout=-1)

<li>QDBusPendingReply< <a class="el" href="a00414.html">Tp::UIntList</a> > <a class="el" href="a00126.html#abfb7d3de4986e5a5039bb199a17e10a4">GetRemotePendingMembers</a> (int timeout=-1)

<li>QDBusPendingReply< uint > <a class="el" href="a00126.html#a5c36599b48a9f43842134499cf61ef2d">GetSelfHandle</a> (int timeout=-1)

<li>QDBusPendingReply <a class="el" href="a00126.html#a68f5efdb73d7f6dcddb638fb05bea959">RemoveMembers</a> (const <a class="el" href="a00414.html">Tp::UIntList</a> &contacts, const QString &message, int timeout=-1)

<li>QDBusPendingReply <a class="el" href="a00126.html#a730c7b58b679aa14cdeeb20e468643cb">RemoveMembersWithReason</a> (const <a class="el" href="a00414.html">Tp::UIntList</a> &contacts, const QString &message, uint reason, int timeout=-1)

</ul>

Signals</h2>

<ul>

<li>void <a class="el" href="a00126.html#a0b5e0a8cf6d7b511a59b6aa6e02e468a">HandleOwnersChanged</a> (const <a class="el" href="a00247.html">Tp::HandleOwnerMap</a> &added, const <a class="el" href="a00414.html">Tp::UIntList</a> &removed)

<li>void <a class="el" href="a00126.html#a884c6ce068ac8f57a5c28a9aa958ab0f">HandleOwnersChangedDetailed</a> (const <a class="el" href="a00247.html">Tp::HandleOwnerMap</a> &added, const <a class="el" href="a00414.html">Tp::UIntList</a> &removed, const <a class="el" href="a00246.html">Tp::HandleIdentifierMap</a> &identifiers)

<li>void <a class="el" href="a00126.html#a7538d2aae49e96eafb247af84b749ed1">SelfHandleChanged</a> (uint selfHandle)

<li>void <a class="el" href="a00126.html#ae14a905b4aa426ac8d39eede78fa3e1a">SelfContactChanged</a> (uint selfHandle, const QString &selfID)

<li>void <a class="el" href="a00126.html#aff24670319166febb52fbdd07f1ae1d4">GroupFlagsChanged</a> (uint added, uint removed)

<li>void <a class="el" href="a00126.html#a8fd1f5fe36448c5f32c8d35bca1af3c1">MembersChanged</a> (const QString &message, const <a class="el" href="a00414.html">Tp::UIntList</a> &added, const <a class="el" href="a00414.html">Tp::UIntList</a> &removed, const <a class="el" href="a00414.html">Tp::UIntList</a> &localPending, const <a class="el" href="a00414.html">Tp::UIntList</a> &remotePending, uint actor, uint reason)

<li>void <a class="el" href="a00126.html#ac840dd1ed0232d40ddaec4b2ffe6b289">MembersChangedDetailed</a> (const <a class="el" href="a00414.html">Tp::UIntList</a> &added, const <a class="el" href="a00414.html">Tp::UIntList</a> &removed, const <a class="el" href="a00414.html">Tp::UIntList</a> &localPending, const <a class="el" href="a00414.html">Tp::UIntList</a> &remotePending, const QVariantMap &details)

</ul>

Public Member Functions</h2>

<ul>

<li><a class="el" href="a00126.html#a8dc738ab020099112172d46f81cbfea7">ChannelInterfaceGroupInterface</a> (const QString &busName, const QString &objectPath, QObject *parent=0)

<li><a class="el" href="a00126.html#aa8d44d8da94dc3d52ac6676abd03344f">ChannelInterfaceGroupInterface</a> (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)

<li><a class="el" href="a00126.html#a9f19860cd372053b2a26b3b9872b3966">ChannelInterfaceGroupInterface</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *proxy)

<li><a class="el" href="a00126.html#a119c2047d24a622af97d9a804380b6ba">ChannelInterfaceGroupInterface</a> (const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &mainInterface)

<li><a class="el" href="a00126.html#ab9c5248b077b7b05f480ed923b999857">ChannelInterfaceGroupInterface</a> (const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &mainInterface, QObject *parent)

<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">requestPropertyGroupFlags</a> () const

<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00126.html#a40b5642f56029baddf910bc36615bb80">requestPropertyHandleOwners</a> () const

<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00126.html#ae3bc5b0510c7d6732846bc81e7d58579">requestPropertyLocalPendingMembers</a> () const

<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00126.html#aabef4247d36d5d5311024ce5a4a746d2">requestPropertyMembers</a> () const

<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00126.html#ab2282518e6a9fcc62da8c2af5748c955">requestPropertyRemotePendingMembers</a> () const

<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00126.html#a97cc43cea0aad7761a3056412ea502be">requestPropertySelfHandle</a> () const

<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00126.html#a700c7ac5d6249d2d3c77bd49cc2c8809">requestPropertyMemberIdentifiers</a> () const

<li><a class="el" href="a00330.html">Tp::PendingVariantMap</a> * <a class="el" href="a00126.html#a44dccb58c143ee15afec7d21b045a76a">requestAllProperties</a> () const

100

</ul>

101

102

Static Public Member Functions</h2>

103

<ul>

104

<li>static QLatin1String <a class="el" href="a00126.html#a1f6b3019b28cf8c787a4dea326876262">staticInterfaceName</a> ()

105

</ul>

106

107

Protected Member Functions</h2>

108

<ul>

109

<li>virtual void <a class="el" href="a00126.html#ab54c77e9528266c565ec417791e6f546">invalidate</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *, const QString &, const QString &)

110

</ul>

111

<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>

112

<div class="textblock"><p>Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Group". </p>

113

</div><hr/><h2>Constructor & Destructor Documentation</h2>

114

115

116

117

118

<tr>

119

<td class="memname"><a class="el" href="a00126.html#a8dc738ab020099112172d46f81cbfea7">Tp::Client::ChannelInterfaceGroupInterface::ChannelInterfaceGroupInterface</a> </td>

120

121

<td class="paramtype">const QString & </td>

122

<td class="paramname"><em>busName</em>, </td>

123

</tr>

124

<tr>

125

126

127

<td class="paramtype">const QString & </td>

128

<td class="paramname"><em>objectPath</em>, </td>

129

</tr>

130

<tr>

131

132

133

<td class="paramtype">QObject * </td>

134

<td class="paramname"><em>parent</em> = <code>0</code> </td>

135

</tr>

136

<tr>

137

138

139

140

</tr>

141

</table>

142

</div>

143

144

<p>Creates a <a class="el" href="a00126.html">ChannelInterfaceGroupInterface</a> associated with the given object on the session bus.</p>

145

<dl class="params"><dt><b>Parameters:</b></dt><dd>

146

147

<tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>

148

<tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>

149

<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>

150

</table>

151

</dd>

152

</dl>

153

154

</div>

155

</div>

156

157

158

159

160

<tr>

161

<td class="memname"><a class="el" href="a00126.html#a8dc738ab020099112172d46f81cbfea7">Tp::Client::ChannelInterfaceGroupInterface::ChannelInterfaceGroupInterface</a> </td>

162

163

<td class="paramtype">const QDBusConnection & </td>

164

<td class="paramname"><em>connection</em>, </td>

165

</tr>

166

<tr>

167

168

169

<td class="paramtype">const QString & </td>

170

<td class="paramname"><em>busName</em>, </td>

171

</tr>

172

<tr>

173

174

175

<td class="paramtype">const QString & </td>

176

<td class="paramname"><em>objectPath</em>, </td>

177

</tr>

178

<tr>

179

180

181

<td class="paramtype">QObject * </td>

182

<td class="paramname"><em>parent</em> = <code>0</code> </td>

183

</tr>

184

<tr>

185

186

187

188

</tr>

189

</table>

190

</div>

191

192

<p>Creates a <a class="el" href="a00126.html">ChannelInterfaceGroupInterface</a> associated with the given object on the given bus.</p>

193

<dl class="params"><dt><b>Parameters:</b></dt><dd>

194

195

<tr><td class="paramname">connection</td><td>The bus via which the object can be reached. </td></tr>

196

<tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>

197

<tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>

198

<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>

199

</table>

200

</dd>

201

</dl>

202

203

</div>

204

</div>

205

206

207

208

209

<tr>

210

<td class="memname"><a class="el" href="a00126.html#a8dc738ab020099112172d46f81cbfea7">Tp::Client::ChannelInterfaceGroupInterface::ChannelInterfaceGroupInterface</a> </td>

211

212

<td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> * </td>

213

<td class="paramname"><em>proxy</em></td><td>)</td>

214

215

</tr>

216

</table>

217

</div>

218

219

<p>Creates a <a class="el" href="a00126.html">ChannelInterfaceGroupInterface</a> associated with the same object as the given proxy.</p>

220

<dl class="params"><dt><b>Parameters:</b></dt><dd>

221

222

<tr><td class="paramname">proxy</td><td>The proxy to use. It will also be the QObject::parent() for this object. </td></tr>

223

</table>

224

</dd>

225

</dl>

226

227

</div>

228

</div>

229

230

231

232

233

<tr>

234

<td class="memname"><a class="el" href="a00126.html#a8dc738ab020099112172d46f81cbfea7">Tp::Client::ChannelInterfaceGroupInterface::ChannelInterfaceGroupInterface</a> </td>

235

236

<td class="paramtype">const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> & </td>

237

<td class="paramname"><em>mainInterface</em></td><td>)</td>

238

<td><code> [explicit]</code></td>

239

</tr>

240

</table>

241

</div>

242

243

<p>Creates a <a class="el" href="a00126.html">ChannelInterfaceGroupInterface</a> associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.</p>

244

<dl class="params"><dt><b>Parameters:</b></dt><dd>

245

246

<tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>

247

</table>

248

</dd>

249

</dl>

250

251

</div>

252

</div>

253

254

255

256

257

<tr>

258

<td class="memname"><a class="el" href="a00126.html#a8dc738ab020099112172d46f81cbfea7">Tp::Client::ChannelInterfaceGroupInterface::ChannelInterfaceGroupInterface</a> </td>

259

260

<td class="paramtype">const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> & </td>

261

<td class="paramname"><em>mainInterface</em>, </td>

262

</tr>

263

<tr>

264

265

266

<td class="paramtype">QObject * </td>

267

<td class="paramname"><em>parent</em> </td>

268

</tr>

269

<tr>

270

271

272

273

</tr>

274

</table>

275

</div>

276

277

<p>Creates a <a class="el" href="a00126.html">ChannelInterfaceGroupInterface</a> associated with the same object as the given proxy. However, a different parent object can be specified.</p>

278

<dl class="params"><dt><b>Parameters:</b></dt><dd>

279

280

<tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>

281

<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>

282

</table>

283

</dd>

284

</dl>

285

286

</div>

287

</div>

288

<hr/><h2>Member Function Documentation</h2>

289

290

291

292

293

<tr>

294

<td class="memname">static QLatin1String <a class="el" href="a00126.html#a1f6b3019b28cf8c787a4dea326876262">Tp::Client::ChannelInterfaceGroupInterface::staticInterfaceName</a> </td>

295

296

297

<td><code> [inline, static]</code></td>

298

</tr>

299

</table>

300

</div>

301

302

<p>Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Group", which this class represents.</p>

303

<dl class="return"><dt><b>Returns:</b></dt><dd>The D-Bus interface name. </dd></dl>

304

305

</div>

306

</div>

307

308

309

310

311

<tr>

312

<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">Tp::Client::ChannelInterfaceGroupInterface::requestPropertyGroupFlags</a> </td>

313

314

315

<td> const<code> [inline]</code></td>

316

</tr>

317

</table>

318

</div>

319

320

<p>Asynchronous getter for the remote object property <code>GroupFlags</code> of type <code>uint</code>.</p>

321

<p>An integer representing the bitwise-OR of flags on this channel. The user interface can use this to present information about which operations are currently valid. Change notification is via the GroupFlagsChanged signal.</p>

322

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>

323

324

</div>

325

</div>

326

327

328

329

330

<tr>

331

<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00126.html#a40b5642f56029baddf910bc36615bb80">Tp::Client::ChannelInterfaceGroupInterface::requestPropertyHandleOwners</a> </td>

332

333

334

<td> const<code> [inline]</code></td>

335

</tr>

336

</table>

337

</div>

338

339

<p>Asynchronous getter for the remote object property <code>HandleOwners</code> of type <code><a class="el" href="a00247.html">Tp::HandleOwnerMap</a></code>.</p>

340

<p>A map from channel-specific handles to their owners, including at least all of the channel-specific handles in this channel's members, local-pending or remote-pending sets as keys. Any handle not in the keys of this mapping is not channel-specific in this channel. Handles which are channel-specific, but for which the owner is unknown, MUST appear in this mapping with 0 as owner. Change notification is via the HandleOwnersChanged signal.</p>

341

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>

342

343

</div>

344

</div>

345

346

347

348

349

<tr>

350

<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00126.html#ae3bc5b0510c7d6732846bc81e7d58579">Tp::Client::ChannelInterfaceGroupInterface::requestPropertyLocalPendingMembers</a> </td>

351

352

353

<td> const<code> [inline]</code></td>

354

</tr>

355

</table>

356

</div>

357

358

<p>Asynchronous getter for the remote object property <code>LocalPendingMembers</code> of type <code><a class="el" href="a00761.html#gac97059fe5c133488d4dcfec37f43df7b">Tp::LocalPendingInfoList</a></code>.</p>

359

<p>An array of structs containing handles representing contacts requesting channel membership and awaiting local approval with AddMembers.</p>

360

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>

361

362

</div>

363

</div>

364

365

366

367

368

<tr>

369

<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00126.html#aabef4247d36d5d5311024ce5a4a746d2">Tp::Client::ChannelInterfaceGroupInterface::requestPropertyMembers</a> </td>

370

371

372

<td> const<code> [inline]</code></td>

373

</tr>

374

</table>

375

</div>

376

377

<p>Asynchronous getter for the remote object property <code>Members</code> of type <code><a class="el" href="a00414.html">Tp::UIntList</a></code>.</p>

378

<p>The members of this channel.</p>

379

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>

380

381

</div>

382

</div>

383

384

385

386

387

<tr>

388

<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00126.html#ab2282518e6a9fcc62da8c2af5748c955">Tp::Client::ChannelInterfaceGroupInterface::requestPropertyRemotePendingMembers</a> </td>

389

390

391

<td> const<code> [inline]</code></td>

392

</tr>

393

</table>

394

</div>

395

396

<p>Asynchronous getter for the remote object property <code>RemotePendingMembers</code> of type <code><a class="el" href="a00414.html">Tp::UIntList</a></code>.</p>

397

<p>An array of handles representing contacts who have been invited to the channel and are awaiting remote approval.</p>

398

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>

399

400

</div>

401

</div>

402

403

404

405

406

<tr>

407

<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00126.html#a97cc43cea0aad7761a3056412ea502be">Tp::Client::ChannelInterfaceGroupInterface::requestPropertySelfHandle</a> </td>

408

409

410

<td> const<code> [inline]</code></td>

411

</tr>

412

</table>

413

</div>

414

415

<p>Asynchronous getter for the remote object property <code>SelfHandle</code> of type <code>uint</code>.</p>

416

<p>The handle for the user on this channel (which can also be a local or remote pending member), or 0 if the user is not a member at all (which is likely to be the case, for instance, on ContactList channels). Note that this is different from the result of Connection.GetSelfHandle on some protocols, so the value of this handle should always be used with the methods of this interface.</p>

417

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>

418

419

</div>

420

</div>

421

422

423

424

425

<tr>

426

<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00126.html#a700c7ac5d6249d2d3c77bd49cc2c8809">Tp::Client::ChannelInterfaceGroupInterface::requestPropertyMemberIdentifiers</a> </td>

427

428

429

<td> const<code> [inline]</code></td>

430

</tr>

431

</table>

432

</div>

433

434

<p>Asynchronous getter for the remote object property <code>MemberIdentifiers</code> of type <code><a class="el" href="a00246.html">Tp::HandleIdentifierMap</a></code>.</p>

435

<p>The string identifiers for handles mentioned in this channel, to give clients the minimal information necessary to create contacts without waiting for round-trips. <a class="el" href="a00161.html" title="The Connection class represents a Telepathy connection.">Connection</a> managers MUST include at least the identifiers for SelfHandle, Members, LocalPendingMembers (and their actors if any), RemotePendingMembers and HandleOwners.</p>

436

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>

437

438

</div>

439

</div>

440

441

442

443

444

<tr>

445

<td class="memname"><a class="el" href="a00330.html">Tp::PendingVariantMap</a>* <a class="el" href="a00126.html#a44dccb58c143ee15afec7d21b045a76a">Tp::Client::ChannelInterfaceGroupInterface::requestAllProperties</a> </td>

446

447

448

<td> const<code> [inline]</code></td>

449

</tr>

450

</table>

451

</div>

452

453

<p>Request all of the <a class="el" href="a00729.html">DBus</a> properties on the interface.</p>

454

<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant map which will emit finished when the properties have been retrieved. </dd></dl>

455

456

</div>

457

</div>

458

459

460

461

462

<tr>

463

<td class="memname">QDBusPendingReply <a class="el" href="a00126.html#a679717c703b0c51ebc9dc1ff6a248693">Tp::Client::ChannelInterfaceGroupInterface::AddMembers</a> </td>

464

465

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

466

<td class="paramname"><em>contacts</em>, </td>

467

</tr>

468

<tr>

469

470

471

<td class="paramtype">const QString & </td>

472

<td class="paramname"><em>message</em>, </td>

473

</tr>

474

<tr>

475

476

477

478

<td class="paramname"><em>timeout</em> = <code>-1</code> </td>

479

</tr>

480

<tr>

481

482

483

<td></td><td><code> [inline, slot]</code></td>

484

</tr>

485

</table>

486

</div>

487

488

<p>Begins a call to the D-Bus method <code>AddMembers</code> on the remote object.</p>

489

490

<p>Invite all the given contacts into the channel, or accept requests for

491

channel membership for contacts on the pending local list.</p>

492

493

<p>A message may be provided along with the request, which will be sent

494

to the server if supported. See the CHANNEL_GROUP_FLAG_MESSAGE_ADD and

495

CHANNEL_GROUP_FLAG_MESSAGE_ACCEPT

496

<a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">GroupFlags </a> to see in which cases this

497

message should be provided.</p>

498

499

<p>Attempting to add contacts who are already members is allowed;

500

connection managers must silently accept this, without error.</p>

501

<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>

502

<dl class="params"><dt><b>Parameters:</b></dt><dd>

503

504

<tr><td class="paramname">contacts</td><td>An array of contact handles to invite to the channel</td></tr>

505

<tr><td class="paramname">message</td><td>A string message, which can be blank if desired </td></tr>

506

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>

507

</table>

508

</dd>

509

</dl>

510

511

</div>

512

</div>

513

514

515

516

517

<tr>

518

<td class="memname">QDBusPendingReply<<a class="el" href="a00414.html">Tp::UIntList</a>, <a class="el" href="a00414.html">Tp::UIntList</a>, <a class="el" href="a00414.html">Tp::UIntList</a>> <a class="el" href="a00126.html#ac801b6c6f0174090f556d4451fd94fd7">Tp::Client::ChannelInterfaceGroupInterface::GetAllMembers</a> </td>

519

520

521

<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>

522

<td><code> [inline, slot]</code></td>

523

</tr>

524

</table>

525

</div>

526

527

<p>Begins a call to the D-Bus method <code>GetAllMembers</code> on the remote object.</p>

528

<p>Returns arrays of all current, local and remote pending channel members.</p>

529

530

<dl class="params"><dt><b>Parameters:</b></dt><dd>

531

532

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>

533

</table>

534

</dd>

535

</dl>

536

<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

537

<p>array of handles of current members</p>

538

<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

539

<p>array of handles of local pending members</p>

540

<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

541

<p>array of handles of remote pending members </p>

542

543

</div>

544

</div>

545

546

547

548

549

<tr>

550

<td class="memname">QDBusPendingReply<uint> <a class="el" href="a00126.html#ad307d230353b15975e824b9becee2bf0">Tp::Client::ChannelInterfaceGroupInterface::GetGroupFlags</a> </td>

551

552

553

<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>

554

<td><code> [inline, slot]</code></td>

555

</tr>

556

</table>

557

</div>

558

559

<p>Begins a call to the D-Bus method <code>GetGroupFlags</code> on the remote object.</p>

560

<p>Returns the value of the GroupFlags property.</p>

561

562

<dl class="params"><dt><b>Parameters:</b></dt><dd>

563

564

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>

565

</table>

566

</dd>

567

</dl>

568

<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

569

<p>The value of the GroupFlags property </p>

570

571

</div>

572

</div>

573

574

575

576

577

<tr>

578

<td class="memname">QDBusPendingReply<<a class="el" href="a00414.html">Tp::UIntList</a>> <a class="el" href="a00126.html#ae124118f5339d05e033018c1d540b9b9">Tp::Client::ChannelInterfaceGroupInterface::GetHandleOwners</a> </td>

579

580

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

581

<td class="paramname"><em>handles</em>, </td>

582

</tr>

583

<tr>

584

585

586

587

<td class="paramname"><em>timeout</em> = <code>-1</code> </td>

588

</tr>

589

<tr>

590

591

592

<td></td><td><code> [inline, slot]</code></td>

593

</tr>

594

</table>

595

</div>

596

597

<p>Begins a call to the D-Bus method <code>GetHandleOwners</code> on the remote object.</p>

598

<p>If the CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES flag is set on the channel, then the handles of the group members are specific to this channel, and are not meaningful in a connection-wide context such as contact lists. This method allows you to find the owner of the handle if it can be discovered in this channel, or 0 if the owner is not available.</p>

599

600

<dl class="params"><dt><b>Parameters:</b></dt><dd>

601

602

<tr><td class="paramname">handles</td><td>A list of integer handles representing members of the channel </td></tr>

603

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>

604

</table>

605

</dd>

606

</dl>

607

<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

608

<p>An array of integer handles representing the owner handles of the given room members, in the same order, or 0 if the owner is not available </p>

609

610

</div>

611

</div>

612

613

614

615

616

<tr>

617

<td class="memname">QDBusPendingReply<<a class="el" href="a00414.html">Tp::UIntList</a>> <a class="el" href="a00126.html#a71a77339bd0c81193ef4ab7501495e20">Tp::Client::ChannelInterfaceGroupInterface::GetLocalPendingMembers</a> </td>

618

619

620

<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>

621

<td><code> [inline, slot]</code></td>

622

</tr>

623

</table>

624

</div>

625

626

<p>Begins a call to the D-Bus method <code>GetLocalPendingMembers</code> on the remote object.</p>

627

<p>Returns the To_Be_Added handle (only) for each structure in the LocalPendingMembers property.</p>

628

629

<dl class="params"><dt><b>Parameters:</b></dt><dd>

630

631

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>

632

</table>

633

</dd>

634

</dl>

635

636

</div>

637

</div>

638

639

640

641

642

<tr>

643

<td class="memname">QDBusPendingReply<<a class="el" href="a00761.html#gac97059fe5c133488d4dcfec37f43df7b">Tp::LocalPendingInfoList</a>> <a class="el" href="a00126.html#a672af560e2335b00a096b69702c2cdde">Tp::Client::ChannelInterfaceGroupInterface::GetLocalPendingMembersWithInfo</a> </td>

644

645

646

<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>

647

<td><code> [inline, slot]</code></td>

648

</tr>

649

</table>

650

</div>

651

652

<p>Begins a call to the D-Bus method <code>GetLocalPendingMembersWithInfo</code> on the remote object.</p>

653

<p>Returns the LocalPendingMembers property.</p>

654

655

<dl class="params"><dt><b>Parameters:</b></dt><dd>

656

657

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>

658

</table>

659

</dd>

660

</dl>

661

<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

662

<p>An array of structs containing: A handle representing the contact requesting channel membership A handle representing the contact making the request, or 0 if unknown The reason for the request: one of the values of Channel_Group_Change_Reason A string message containing the reason for the request if any (or blank if none) </p>

663

664

</div>

665

</div>

666

667

668

669

670

<tr>

671

<td class="memname">QDBusPendingReply<<a class="el" href="a00414.html">Tp::UIntList</a>> <a class="el" href="a00126.html#a002272a6c67ee7682f32cd318b3d7058">Tp::Client::ChannelInterfaceGroupInterface::GetMembers</a> </td>

672

673

674

<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>

675

<td><code> [inline, slot]</code></td>

676

</tr>

677

</table>

678

</div>

679

680

<p>Begins a call to the D-Bus method <code>GetMembers</code> on the remote object.</p>

681

<p>Returns the Members property.</p>

682

683

<dl class="params"><dt><b>Parameters:</b></dt><dd>

684

685

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>

686

</table>

687

</dd>

688

</dl>

689

690

</div>

691

</div>

692

693

694

695

696

<tr>

697

<td class="memname">QDBusPendingReply<<a class="el" href="a00414.html">Tp::UIntList</a>> <a class="el" href="a00126.html#abfb7d3de4986e5a5039bb199a17e10a4">Tp::Client::ChannelInterfaceGroupInterface::GetRemotePendingMembers</a> </td>

698

699

700

<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>

701

<td><code> [inline, slot]</code></td>

702

</tr>

703

</table>

704

</div>

705

706

<p>Begins a call to the D-Bus method <code>GetRemotePendingMembers</code> on the remote object.</p>

707

<p>Returns an array of handles representing contacts who have been invited to the channel and are awaiting remote approval.</p>

708

709

<dl class="params"><dt><b>Parameters:</b></dt><dd>

710

711

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>

712

</table>

713

</dd>

714

</dl>

715

716

</div>

717

</div>

718

719

720

721

722

<tr>

723

<td class="memname">QDBusPendingReply<uint> <a class="el" href="a00126.html#a5c36599b48a9f43842134499cf61ef2d">Tp::Client::ChannelInterfaceGroupInterface::GetSelfHandle</a> </td>

724

725

726

<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>

727

<td><code> [inline, slot]</code></td>

728

</tr>

729

</table>

730

</div>

731

732

<p>Begins a call to the D-Bus method <code>GetSelfHandle</code> on the remote object.</p>

733

<p>Returns the value of the SelfHandle property.</p>

734

735

<dl class="params"><dt><b>Parameters:</b></dt><dd>

736

737

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>

738

</table>

739

</dd>

740

</dl>

741

742

</div>

743

</div>

744

745

746

747

748

<tr>

749

<td class="memname">QDBusPendingReply <a class="el" href="a00126.html#a68f5efdb73d7f6dcddb638fb05bea959">Tp::Client::ChannelInterfaceGroupInterface::RemoveMembers</a> </td>

750

751

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

752

<td class="paramname"><em>contacts</em>, </td>

753

</tr>

754

<tr>

755

756

757

<td class="paramtype">const QString & </td>

758

<td class="paramname"><em>message</em>, </td>

759

</tr>

760

<tr>

761

762

763

764

<td class="paramname"><em>timeout</em> = <code>-1</code> </td>

765

</tr>

766

<tr>

767

768

769

<td></td><td><code> [inline, slot]</code></td>

770

</tr>

771

</table>

772

</div>

773

774

<p>Begins a call to the D-Bus method <code>RemoveMembers</code> on the remote object.</p>

775

776

<p>Requests the removal of contacts from a channel, reject their

777

request for channel membership on the pending local list, or

778

rescind their invitation on the pending remote list.</p>

779

780

<p>If the <a class="el" href="a00126.html#a97cc43cea0aad7761a3056412ea502be">SelfHandle </a> is in a Group,

781

it can be removed via this method, in order to leave the group

782

gracefully. This is the recommended way to leave a chatroom, close

783

or reject a <a class="el" href="a00148.html">ChannelTypeStreamedMediaInterface</a>

784

call, and so on.</p>

785

786

<p>Accordingly, connection managers SHOULD support

787

doing this, regardless of the value of

788

<a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">GroupFlags </a> .

789

If doing so fails with PermissionDenied, this is considered to a bug

790

in the connection manager, but clients MUST recover by falling back

791

to closing the channel with the <a class="el" href="a00117.html#a822439bf7adb2ce890cf8066ea01a1ff">ChannelInterface::Close()</a>

792

method.</p>

793

794

<p>Removing any contact from the local pending list is always

795

allowed. Removing contacts other than the

796

<a class="el" href="a00126.html#a97cc43cea0aad7761a3056412ea502be">SelfHandle </a> from the channel's members

797

is allowed if and only if Channel_Group_Flag_Can_Remove is in the

798

<a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">GroupFlags </a> ,

799

while removing contacts other than the

800

<a class="el" href="a00126.html#a97cc43cea0aad7761a3056412ea502be">SelfHandle </a> from the remote pending list

801

is allowed if and only if Channel_Group_Flag_Can_Rescind is in the

802

<a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">GroupFlags </a> .</p>

803

804

<p>A message may be provided along with the request, which will be

805

sent to the server if supported. See the

806

Channel_Group_Flag_Message_Remove,

807

Channel_Group_Flag_Message_Depart,

808

Channel_Group_Flag_Message_Reject and

809

Channel_Group_Flag_Message_Rescind

810

<a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">GroupFlags </a> to see in which cases this

811

message should be provided.</p>

812

813

<dl class="params"><dt><b>Parameters:</b></dt><dd>

814

815

<tr><td class="paramname">contacts</td><td>An array of contact handles to remove from the channel</td></tr>

816

<tr><td class="paramname">message</td><td>A string message, which can be blank if desired </td></tr>

817

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>

818

</table>

819

</dd>

820

</dl>

821

822

</div>

823

</div>

824

825

826

827

828

<tr>

829

<td class="memname">QDBusPendingReply <a class="el" href="a00126.html#a730c7b58b679aa14cdeeb20e468643cb">Tp::Client::ChannelInterfaceGroupInterface::RemoveMembersWithReason</a> </td>

830

831

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

832

<td class="paramname"><em>contacts</em>, </td>

833

</tr>

834

<tr>

835

836

837

<td class="paramtype">const QString & </td>

838

<td class="paramname"><em>message</em>, </td>

839

</tr>

840

<tr>

841

842

843

844

<td class="paramname"><em>reason</em>, </td>

845

</tr>

846

<tr>

847

848

849

850

<td class="paramname"><em>timeout</em> = <code>-1</code> </td>

851

</tr>

852

<tr>

853

854

855

<td></td><td><code> [inline, slot]</code></td>

856

</tr>

857

</table>

858

</div>

859

860

<p>Begins a call to the D-Bus method <code>RemoveMembersWithReason</code> on the remote object.</p>

861

<p>As RemoveMembers, but a reason code may be provided where appropriate. The reason code may be ignored if the underlying protocol is unable to represent the given reason.</p>

862

863

<dl class="params"><dt><b>Parameters:</b></dt><dd>

864

865

<tr><td class="paramname">contacts</td><td>An array of contact handles to remove from the channel</td></tr>

866

<tr><td class="paramname">message</td><td>A string message, which can be blank if desired</td></tr>

867

<tr><td class="paramname">reason</td><td>A reason for the change </td></tr>

868

<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>

869

</table>

870

</dd>

871

</dl>

872

873

</div>

874

</div>

875

876

877

878

879

<tr>

880

<td class="memname">void <a class="el" href="a00126.html#a0b5e0a8cf6d7b511a59b6aa6e02e468a">Tp::Client::ChannelInterfaceGroupInterface::HandleOwnersChanged</a> </td>

881

882

<td class="paramtype">const <a class="el" href="a00247.html">Tp::HandleOwnerMap</a> & </td>

883

<td class="paramname"><em>added</em>, </td>

884

</tr>

885

<tr>

886

887

888

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

889

<td class="paramname"><em>removed</em> </td>

890

</tr>

891

<tr>

892

893

894

<td></td><td><code> [signal]</code></td>

895

</tr>

896

</table>

897

</div>

898

899

<p>Represents the signal <code>HandleOwnersChanged</code> on the remote object.</p>

900

<p>Emitted whenever the HandleOwners property changes.</p>

901

<dl class="params"><dt><b>Parameters:</b></dt><dd>

902

903

<tr><td class="paramname">added</td><td>A map from channel-specific handles to their owners, in which the keys include all the handles that were added to the keys of the HandleOwners property, and all the handles in that property whose owner has changed</td></tr>

904

<tr><td class="paramname">removed</td><td>The channel-specific handles that were removed from the keys of the HandleOwners property, as a result of the contact leaving this group in a previous MembersChanged signal </td></tr>

905

</table>

906

</dd>

907

</dl>

908

909

</div>

910

</div>

911

912

913

914

915

<tr>

916

<td class="memname">void <a class="el" href="a00126.html#a884c6ce068ac8f57a5c28a9aa958ab0f">Tp::Client::ChannelInterfaceGroupInterface::HandleOwnersChangedDetailed</a> </td>

917

918

<td class="paramtype">const <a class="el" href="a00247.html">Tp::HandleOwnerMap</a> & </td>

919

<td class="paramname"><em>added</em>, </td>

920

</tr>

921

<tr>

922

923

924

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

925

<td class="paramname"><em>removed</em>, </td>

926

</tr>

927

<tr>

928

929

930

<td class="paramtype">const <a class="el" href="a00246.html">Tp::HandleIdentifierMap</a> & </td>

931

<td class="paramname"><em>identifiers</em> </td>

932

</tr>

933

<tr>

934

935

936

<td></td><td><code> [signal]</code></td>

937

</tr>

938

</table>

939

</div>

940

941

<p>Represents the signal <code>HandleOwnersChangedDetailed</code> on the remote object.</p>

942

<p>Emitted whenever the HandleOwners property changes. Clients can assume this signal is emitted by the <a class="el" href="a00161.html" title="The Connection class represents a Telepathy connection.">Connection</a> Manager if the MemberIdentifiers property exists</p>

943

<dl class="params"><dt><b>Parameters:</b></dt><dd>

944

945

946

947

<tr><td class="paramname">identifiers</td><td>The string identifiers for handles mentioned in this signal, to give clients the minimal information necessary to create contacts without waiting for round-trips. <a class="el" href="a00161.html" title="The Connection class represents a Telepathy connection.">Connection</a> managers MUST include at least the identifiers for all handles in the Added map, and MAY include those from Removed array. </td></tr>

948

</table>

949

</dd>

950

</dl>

951

952

</div>

953

</div>

954

955

956

957

958

<tr>

959

<td class="memname">void <a class="el" href="a00126.html#a7538d2aae49e96eafb247af84b749ed1">Tp::Client::ChannelInterfaceGroupInterface::SelfHandleChanged</a> </td>

960

961

962

<td class="paramname"><em>selfHandle</em></td><td>)</td>

963

<td><code> [signal]</code></td>

964

</tr>

965

</table>

966

</div>

967

968

<p>Represents the signal <code>SelfHandleChanged</code> on the remote object.</p>

969

<p>Emitted whenever the SelfHandle property changes.</p>

970

<dl class="params"><dt><b>Parameters:</b></dt><dd>

971

972

<tr><td class="paramname">selfHandle</td><td>The new value of the SelfHandle property. </td></tr>

973

</table>

974

</dd>

975

</dl>

976

977

</div>

978

</div>

979

980

981

982

983

<tr>

984

<td class="memname">void <a class="el" href="a00126.html#ae14a905b4aa426ac8d39eede78fa3e1a">Tp::Client::ChannelInterfaceGroupInterface::SelfContactChanged</a> </td>

985

986

987

<td class="paramname"><em>selfHandle</em>, </td>

988

</tr>

989

<tr>

990

991

992

<td class="paramtype">const QString & </td>

993

<td class="paramname"><em>selfID</em> </td>

994

</tr>

995

<tr>

996

997

998

<td></td><td><code> [signal]</code></td>

999

</tr>

1000

</table>

1001

</div>

1002

1003

<p>Represents the signal <code>SelfContactChanged</code> on the remote object.</p>

1004

<p>Emitted whenever the SelfHandle property changes. Clients can assume this signal is emitted by the <a class="el" href="a00161.html" title="The Connection class represents a Telepathy connection.">Connection</a> Manager if the MemberIdentifiers property exists.</p>

1005

<dl class="params"><dt><b>Parameters:</b></dt><dd>

1006

1007

<tr><td class="paramname">selfHandle</td><td>The new value of the SelfHandle property.</td></tr>

1008

<tr><td class="paramname">selfID</td><td>The new value of the SelfHandle property's identifier. </td></tr>

1009

</table>

1010

</dd>

1011

</dl>

1012

1013

</div>

1014

</div>

1015

1016

1017

1018

1019

<tr>

1020

<td class="memname">void <a class="el" href="a00126.html#aff24670319166febb52fbdd07f1ae1d4">Tp::Client::ChannelInterfaceGroupInterface::GroupFlagsChanged</a> </td>

1021

1022

1023

<td class="paramname"><em>added</em>, </td>

1024

</tr>

1025

<tr>

1026

1027

1028

1029

<td class="paramname"><em>removed</em> </td>

1030

</tr>

1031

<tr>

1032

1033

1034

<td></td><td><code> [signal]</code></td>

1035

</tr>

1036

</table>

1037

</div>

1038

1039

<p>Represents the signal <code>GroupFlagsChanged</code> on the remote object.</p>

1040

<p>Emitted when the flags as returned by GetGroupFlags are changed. The user interface should be updated as appropriate.</p>

1041

<dl class="params"><dt><b>Parameters:</b></dt><dd>

1042

1043

<tr><td class="paramname">added</td><td>A bitwise OR of the flags which have been set</td></tr>

1044

<tr><td class="paramname">removed</td><td>A bitwise OR of the flags which have been cleared </td></tr>

1045

</table>

1046

</dd>

1047

</dl>

1048

1049

</div>

1050

</div>

1051

1052

1053

1054

1055

<tr>

1056

<td class="memname">void <a class="el" href="a00126.html#a8fd1f5fe36448c5f32c8d35bca1af3c1">Tp::Client::ChannelInterfaceGroupInterface::MembersChanged</a> </td>

1057

1058

<td class="paramtype">const QString & </td>

1059

<td class="paramname"><em>message</em>, </td>

1060

</tr>

1061

<tr>

1062

1063

1064

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1065

<td class="paramname"><em>added</em>, </td>

1066

</tr>

1067

<tr>

1068

1069

1070

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1071

<td class="paramname"><em>removed</em>, </td>

1072

</tr>

1073

<tr>

1074

1075

1076

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1077

<td class="paramname"><em>localPending</em>, </td>

1078

</tr>

1079

<tr>

1080

1081

1082

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1083

<td class="paramname"><em>remotePending</em>, </td>

1084

</tr>

1085

<tr>

1086

1087

1088

1089

<td class="paramname"><em>actor</em>, </td>

1090

</tr>

1091

<tr>

1092

1093

1094

1095

<td class="paramname"><em>reason</em> </td>

1096

</tr>

1097

<tr>

1098

1099

1100

<td></td><td><code> [signal]</code></td>

1101

</tr>

1102

</table>

1103

</div>

1104

1105

<p>Represents the signal <code>MembersChanged</code> on the remote object.</p>

1106

1107

<p>Emitted when contacts join any of the three lists (members, local

1108

pending or remote pending) or when they leave any of the three lists.

1109

There may also be a message from the server regarding this change,

1110

which may be displayed to the user if desired.</p>

1111

1112

<p>All channel-specific handles that are mentioned in this signal

1113

MUST be represented in the value of the

1114

<a class="el" href="a00126.html#a40b5642f56029baddf910bc36615bb80">HandleOwners </a> property.

1115

In practice, this will mean that

1116

<a class="el" href="a00126.html#a0b5e0a8cf6d7b511a59b6aa6e02e468a">HandleOwnersChanged()</a> is

1117

emitted <em>before</em> emitting a MembersChanged signal in which

1118

channel-specific handles are added, but that it is emitted

1119

<em>after</em> emitting a MembersChanged signal in which

1120

channel-specific handles are removed.</p>

1121

1122

<p>See <a class="el" href="a00148.html">ChannelTypeStreamedMediaInterface</a>

1123

for an overview of how group state changes are used to indicate the

1124

progress of a call.</p>

1125

<dl class="params"><dt><b>Parameters:</b></dt><dd>

1126

1127

<tr><td class="paramname">message</td><td>A string message from the server, or blank if not</td></tr>

1128

<tr><td class="paramname">added</td><td>A list of members added to the channel</td></tr>

1129

<tr><td class="paramname">removed</td><td>A list of members removed from the channel</td></tr>

1130

<tr><td class="paramname">localPending</td><td>A list of members who are pending local approval</td></tr>

1131

<tr><td class="paramname">remotePending</td><td>A list of members who are pending remote approval</td></tr>

1132

<tr><td class="paramname">actor</td><td>The contact handle of the person who made the change, or 0 if not known</td></tr>

1133

<tr><td class="paramname">reason</td><td>A reason for the change </td></tr>

1134

</table>

1135

</dd>

1136

</dl>

1137

1138

</div>

1139

</div>

1140

1141

1142

1143

1144

<tr>

1145

<td class="memname">void <a class="el" href="a00126.html#ac840dd1ed0232d40ddaec4b2ffe6b289">Tp::Client::ChannelInterfaceGroupInterface::MembersChangedDetailed</a> </td>

1146

1147

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1148

<td class="paramname"><em>added</em>, </td>

1149

</tr>

1150

<tr>

1151

1152

1153

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1154

<td class="paramname"><em>removed</em>, </td>

1155

</tr>

1156

<tr>

1157

1158

1159

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1160

<td class="paramname"><em>localPending</em>, </td>

1161

</tr>

1162

<tr>

1163

1164

1165

<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>

1166

<td class="paramname"><em>remotePending</em>, </td>

1167

</tr>

1168

<tr>

1169

1170

1171

<td class="paramtype">const QVariantMap & </td>

1172

<td class="paramname"><em>details</em> </td>

1173

</tr>

1174

<tr>

1175

1176

1177

<td></td><td><code> [signal]</code></td>

1178

</tr>

1179

</table>

1180

</div>

1181

1182

<p>Represents the signal <code>MembersChangedDetailed</code> on the remote object.</p>

1183

1184

<p>Emitted when contacts join any of the three lists (members, local

1185

pending or remote pending) or when they leave any of the three

1186

lists. This signal provides a superset of the information provided by

1187

<a class="el" href="a00126.html#a8fd1f5fe36448c5f32c8d35bca1af3c1">MembersChanged()</a> ;

1188

if the channel's <a class="el" href="a00126.html#a93a5eb6f41bedc6c57a25bebf81626b5">GroupFlags </a>

1189

contains Members_Changed_Detailed, then clients may listen exclusively

1190

to this signal in preference to that signal.</p>

1191

1192

<p>All channel-specific handles that are mentioned in this signal

1193

MUST be represented in the value of the

1194

<a class="el" href="a00126.html#a40b5642f56029baddf910bc36615bb80">HandleOwners </a> property. In practice,

1195

this will mean that

1196

<a class="el" href="a00126.html#a0b5e0a8cf6d7b511a59b6aa6e02e468a">HandleOwnersChanged()</a> is emitted

1197

<em>before</em> emitting a MembersChangedDetailed signal in which

1198

channel-specific handles are added, but that it is emitted

1199

<em>after</em> emitting a MembersChangedDetailed signal in which

1200

channel-specific handles are removed.</p>

1201

1202

<p>See <a class="el" href="a00148.html">ChannelTypeStreamedMediaInterface</a>

1203

for an overview of how group state changes are used to indicate the

1204

progress of a call.</p>

1205

<dl class="params"><dt><b>Parameters:</b></dt><dd>

1206

1207

<tr><td class="paramname">added</td><td>A list of members added to the channel</td></tr>

1208

<tr><td class="paramname">removed</td><td>A list of members removed from the channel</td></tr>

1209

<tr><td class="paramname">localPending</td><td>A list of members who are pending local approval</td></tr>

1210

<tr><td class="paramname">remotePending</td><td>A list of members who are pending remote approval</td></tr>

1211

<tr><td class="paramname">details</td><td>

1212

<p>Information about the change, which may include the following

1213

well-known keys:</p>

1214

1215

<dl>

1216

<dt>actor (u — <tp:type>Contact_Handle</tp:type>)</dt>

1217

<dd>The contact handle of the person who made the change; 0 or

1218

omitted if unknown or not applicable.</dd>

1219

1220

<dt>change-reason (u — <tp:type>Channel_Group_Change_Reason</tp:type>)</dt>

1221

<dd>A reason for the change.</dd>

1222

1223

<dt>contact-ids (a{us} — <tp:type>Handle_Identifier_Map</tp:type>)</dt>

1224

<dd>

1225

<p>The string identifiers for handles mentioned in this signal, to

1226

give clients the minimal information necessary to react to the

1227

event without waiting for round-trips. Connection managers

1228

SHOULD include the identifiers for members added to the group and

1229

for the actor (if any); they MAY omit the identifiers for handles

1230

which have been removed from the group.</p>

1231

1232

1233

<p>On IRC, an event such as a netsplit could cause the vast

1234

majority of a channel to leave. Given that clients should

1235

already know the identifiers of a channel's members, including

1236

potentially hundreds of strings in the netsplit signal is

1237

unnecessary.</p>

1238

</div>

1239

1240

<p>Clients MUST NOT assume that the presence or absence of a

1241

handle in this mapping is meaningful. This mapping is merely

1242

an optimization for round-trip reduction, and connection

1243

managers MAY add additional handles, omit some handles, or

1244

omit the mapping completely.</p>

1245

</dd>

1246

1247

<dt>message (s)</dt>

1248

<dd>A string message from the server regarding the change</dd>

1249

1250

<dt>error (s — <tp:type>DBus_Error_Name</tp:type>)</dt>

1251

<dd>A (possibly implementation-specific) DBus error describing the

1252

change, providing more specific information than the

1253

<tp:type>Channel_Group_Change_Reason</tp:type> enum allows. This

1254

MUST only be present if it is strictly more informative than

1255

'change-reason'; if present, 'change-reason' MUST be set to the

1256

closest available reason.

1257

1258

1259

A SIP connection manager might want to signal "402 Payment

1260

required" as something more specific than Error or

1261

Permission_Denied so that a SIP-aware UI could handle it

1262

specially; including a namespaced error permits this to be done

1263

without <tp:type>Channel_Group_Change_Reason</tp:type> being

1264

extended to encompass every error any CM ever wants to report.

1265

</div>

1266

</dd>

1267

1268

<dt>debug-message (s)</dt>

1269

<dd>Debugging information on the change. SHOULD NOT be shown to

1270

users in normal circumstances.</dd>

1271

</dl>

1272

</td></tr>

1273

</table>

1274

</dd>

1275

</dl>

1276

1277

</div>

1278

</div>

1279

1280

1281

1282

1283

<tr>

1284

<td class="memname">void <a class="el" href="a00126.html#ab54c77e9528266c565ec417791e6f546">Tp::Client::ChannelInterfaceGroupInterface::invalidate</a> </td>

1285

1286

<td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> * </td>

1287

<td class="paramname"><em>proxy</em>, </td>

1288

</tr>

1289

<tr>

1290

1291

1292

<td class="paramtype">const QString & </td>

1293

<td class="paramname"><em>error</em>, </td>

1294

</tr>

1295

<tr>

1296

1297

1298

<td class="paramtype">const QString & </td>

1299

<td class="paramname"><em>message</em> </td>

1300

</tr>

1301

<tr>

1302

1303

1304

<td></td><td><code> [protected, virtual]</code></td>

1305

</tr>

1306

</table>

1307

</div>

1308

1309

1310

<p>Reimplemented from <a class="el" href="a00037.html#a79dde56ba44455f47c7c354ada07467a">Tp::AbstractInterface</a>.</p>

1311

1312

</div>

1313

</div>

1314

</div>

1315

1316

1317

1318

<td width="30%" align="right"><div align="right">Telepathy-Qt 0.9.3</div></td>

1319

</tr></table></div></address>

1320

</body>

1321

</html>

Older »