~ubuntu-branches/ubuntu/quantal/pyxmpp/quantal

<tr><td align="right"><span class="options">[<a href="../private/pyxmpp.jabber.muc.MucRoomHandler-class.html">show private</a> | hide private]</span></td></tr>

<tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a> | <a href="pyxmpp.jabber.muc.MucRoomHandler-class.html" target="_top">no frames</a>]</span></td></tr>

</table></td>

</tr></table>

<h2 class="class">Class MucRoomHandler</h2>

<hr/>

<p>Base class for MUC room handlers.</p>

<p>Methods of this class will be called for various events in the room.</p>

<hr/>

<th colspan="2">Method Summary</th></tr>

<br />

Initialize a <a href="pyxmpp.jabber.muc.MucRoomHandler-class.html" class="link"><code>MucRoomHandler</code></a> object.</td></tr>

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#affiliation_changed" class="summary-sig-name"><code>affiliation_changed</code></a>(<span class="summary-sig-arg">self</span>,

<span class="summary-sig-arg">user</span>,

<span class="summary-sig-arg">old_aff</span>,

<span class="summary-sig-arg">new_aff</span>,

<span class="summary-sig-arg">stanza</span>)</span></code>

<br />

Called when a affiliation of an user has been changed.</td></tr>

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#assign_state" class="summary-sig-name"><code>assign_state</code></a>(<span class="summary-sig-arg">self</span>,

<span class="summary-sig-arg">state_obj</span>)</span></code>

<br />

Assign a state object to this <a href="pyxmpp.jabber.muc.MucRoomHandler-class.html" class="link"><code>MucRoomHandler</code></a> instance.</td></tr>

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#configuration_form_received" class="summary-sig-name"><code>configuration_form_received</code></a>(<span class="summary-sig-arg">self</span>,

<br />

Called when a requested configuration form is received.</td></tr>

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#error" class="summary-sig-name"><code>error</code></a>(<span class="summary-sig-arg">self</span>,

<span class="summary-sig-arg">stanza</span>)</span></code>

<br />

Called when an error stanza is received.</td></tr>

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#message_received" class="summary-sig-name"><code>message_received</code></a>(<span class="summary-sig-arg">self</span>,

<span class="summary-sig-arg">user</span>,

<span class="summary-sig-arg">stanza</span>)</span></code>

<br />

Called when groupchat message has been received.</td></tr>

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#nick_change" class="summary-sig-name"><code>nick_change</code></a>(<span class="summary-sig-arg">self</span>,

<span class="summary-sig-arg">user</span>,

<span class="summary-sig-arg">new_nick</span>,

<span class="summary-sig-arg">stanza</span>)</span></code>

<br />

Called when user nick change is started.</td></tr>

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#nick_changed" class="summary-sig-name"><code>nick_changed</code></a>(<span class="summary-sig-arg">self</span>,

100

<span class="summary-sig-arg">user</span>,

101

<span class="summary-sig-arg">old_nick</span>,

102

<span class="summary-sig-arg">stanza</span>)</span></code>

103

<br />

104

Called after a user nick has been changed.</td></tr>

105

106

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#presence_changed" class="summary-sig-name"><code>presence_changed</code></a>(<span class="summary-sig-arg">self</span>,

107

<span class="summary-sig-arg">user</span>,

108

<span class="summary-sig-arg">stanza</span>)</span></code>

109

<br />

110

Called whenever user's presence changes (includes nick, role or

111

affiliation changes).</td></tr>

112

113

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#role_changed" class="summary-sig-name"><code>role_changed</code></a>(<span class="summary-sig-arg">self</span>,

114

<span class="summary-sig-arg">user</span>,

115

<span class="summary-sig-arg">old_role</span>,

116

<span class="summary-sig-arg">new_role</span>,

117

<span class="summary-sig-arg">stanza</span>)</span></code>

118

<br />

119

Called when a role of an user has been changed.</td></tr>

120

121

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#room_configuration_error" class="summary-sig-name"><code>room_configuration_error</code></a>(<span class="summary-sig-arg">self</span>,

122

<span class="summary-sig-arg">stanza</span>)</span></code>

123

<br />

124

Called when an error stanza is received in reply to a room

125

configuration request.</td></tr>

126

127

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#room_configured" class="summary-sig-name"><code>room_configured</code></a>(<span class="summary-sig-arg">self</span>)</span></code>

128

<br />

129

Called after a successfull room configuration.</td></tr>

130

131

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#room_created" class="summary-sig-name"><code>room_created</code></a>(<span class="summary-sig-arg">self</span>,

132

<span class="summary-sig-arg">stanza</span>)</span></code>

133

<br />

134

Called when the room has been created.</td></tr>

135

136

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#subject_changed" class="summary-sig-name"><code>subject_changed</code></a>(<span class="summary-sig-arg">self</span>,

137

<span class="summary-sig-arg">user</span>,

138

<span class="summary-sig-arg">stanza</span>)</span></code>

139

<br />

140

Called when the room subject has been changed.</td></tr>

141

142

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#user_joined" class="summary-sig-name"><code>user_joined</code></a>(<span class="summary-sig-arg">self</span>,

143

<span class="summary-sig-arg">user</span>,

144

<span class="summary-sig-arg">stanza</span>)</span></code>

145

<br />

146

Called when a new participant joins the room.</td></tr>

147

148

<td><code><span class="summary-sig"><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#user_left" class="summary-sig-name"><code>user_left</code></a>(<span class="summary-sig-arg">self</span>,

149

<span class="summary-sig-arg">user</span>,

150

<span class="summary-sig-arg">stanza</span>)</span></code>

151

<br />

152

Called when a participant leaves the room.</td></tr>

153

</table><br />

154

155

156

157

158

159

<th colspan="2">Instance Variable Summary</th></tr>

160

161

<td><strong><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#room_state"><code>room_state</code></a></strong>: MucRoomState object describing room state and its

162

participants.</td></tr>

163

</table><br />

164

165

166

167

168

169

<th colspan="2">Method Details</th></tr>

170

</table>

171

172

173

174

175

<br /><em class="fname">(Constructor)</em>

176

</h3>

177

Initialize a <a href="pyxmpp.jabber.muc.MucRoomHandler-class.html" class="link"><code>MucRoomHandler</code></a> object. <dl><dt></dt><dd>

178

</dd></dl>

179

</td></tr></table>

180

181

182

183

<h3><span class="sig"><span class="sig-name">affiliation_changed</span>(<span class="sig-arg">self</span>,

184

<span class="sig-arg">user</span>,

185

<span class="sig-arg">old_aff</span>,

186

<span class="sig-arg">new_aff</span>,

187

<span class="sig-arg">stanza</span>)</span>

188

</h3>

189

<p>Called when a affiliation of an user has been changed.</p>

190

<p><a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#affiliation_changed" class="link"><code>user</code></a> MucRoomUser object describing the user (after update).

191

<a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#affiliation_changed" class="link"><code>old_aff</code></a> is user's affiliation before update.

192

<a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#affiliation_changed" class="link"><code>new_aff</code></a> is user's affiliation after update.

193

<a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#affiliation_changed" class="link"><code>stanza</code></a> the stanza received.</p>

194

195

</dd></dl>

196

</td></tr></table>

197

198

199

200

<h3><span class="sig"><span class="sig-name">assign_state</span>(<span class="sig-arg">self</span>,

201

<span class="sig-arg">state_obj</span>)</span>

202

</h3>

203

Assign a state object to this <a href="pyxmpp.jabber.muc.MucRoomHandler-class.html" class="link"><code>MucRoomHandler</code></a> instance. <dl><dt></dt><dd>

204

<dl><dt>Parameters:</dt>

205

<dd><code><strong class="pname">state_obj</strong></code> -

206

the state object.

207

208

(type=<a href="pyxmpp.jabber.muc.MucRoomState-class.html" class="link"><code>MucRoomState</code></a>)</em>

209

</dd>

210

</dl>

211

</dd></dl>

212

</td></tr></table>

213

214

215

216

<h3><span class="sig"><span class="sig-name">configuration_form_received</span>(<span class="sig-arg">self</span>,

217

218

</h3>

219

<p>Called when a requested configuration form is received.</p>

220

<p>The form, after filling-in shoul be passed to <code>self.room_state.configure_room</code>.</p>

221

222

<dl><dt>Parameters:</dt>

223

<dd><code><strong class="pname">form</strong></code> -

224

the configuration form.

225

226

(type=<a href="pyxmpp.jabber.dataforms.Form-class.html" class="link"><code>pyxmpp.jabber.dataforms.Form</code></a>)</em>

227

</dd>

228

</dl>

229

</dd></dl>

230

</td></tr></table>

231

232

233

234

<h3><span class="sig"><span class="sig-name">error</span>(<span class="sig-arg">self</span>,

235

<span class="sig-arg">stanza</span>)</span>

236

</h3>

237

Called when an error stanza is received. <dl><dt></dt><dd>

238

<dl><dt>Parameters:</dt>

239

<dd><code><strong class="pname">stanza</strong></code> -

240

the stanza received.

241

242

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

243

</dd>

244

</dl>

245

</dd></dl>

246

</td></tr></table>

247

248

249

250

<h3><span class="sig"><span class="sig-name">message_received</span>(<span class="sig-arg">self</span>,

251

<span class="sig-arg">user</span>,

252

<span class="sig-arg">stanza</span>)</span>

253

</h3>

254

Called when groupchat message has been received. <dl><dt></dt><dd>

255

<dl><dt>Parameters:</dt>

256

<dd><code><strong class="pname">user</strong></code> -

257

the sender.

258

259

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

260

</dd>

261

<dd><code><strong class="pname">stanza</strong></code> -

262

is the message stanza received.

263

264

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

265

</dd>

266

</dl>

267

</dd></dl>

268

</td></tr></table>

269

270

271

272

<h3><span class="sig"><span class="sig-name">nick_change</span>(<span class="sig-arg">self</span>,

273

<span class="sig-arg">user</span>,

274

<span class="sig-arg">new_nick</span>,

275

<span class="sig-arg">stanza</span>)</span>

276

</h3>

277

Called when user nick change is started. <dl><dt></dt><dd>

278

<dl><dt>Parameters:</dt>

279

<dd><code><strong class="pname">user</strong></code> -

280

the user (before update).

281

282

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

283

</dd>

284

<dd><code><strong class="pname">new_nick</strong></code> -

285

the new nick.

286

287

(type=<code>unicode</code>)</em>

288

</dd>

289

<dd><code><strong class="pname">stanza</strong></code> -

290

the stanza received.

291

292

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

293

</dd>

294

</dl>

295

</dd></dl>

296

</td></tr></table>

297

298

299

300

<h3><span class="sig"><span class="sig-name">nick_changed</span>(<span class="sig-arg">self</span>,

301

<span class="sig-arg">user</span>,

302

<span class="sig-arg">old_nick</span>,

303

<span class="sig-arg">stanza</span>)</span>

304

</h3>

305

Called after a user nick has been changed. <dl><dt></dt><dd>

306

<dl><dt>Parameters:</dt>

307

<dd><code><strong class="pname">user</strong></code> -

308

the user (after update).

309

310

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

311

</dd>

312

<dd><code><strong class="pname">old_nick</strong></code> -

313

the old nick.

314

315

(type=<code>unicode</code>)</em>

316

</dd>

317

<dd><code><strong class="pname">stanza</strong></code> -

318

the stanza received.

319

320

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

321

</dd>

322

</dl>

323

</dd></dl>

324

</td></tr></table>

325

326

327

328

<h3><span class="sig"><span class="sig-name">presence_changed</span>(<span class="sig-arg">self</span>,

329

<span class="sig-arg">user</span>,

330

<span class="sig-arg">stanza</span>)</span>

331

</h3>

332

Called whenever user's presence changes (includes nick, role or

333

affiliation changes). <dl><dt></dt><dd>

334

<dl><dt>Parameters:</dt>

335

<dd><code><strong class="pname">user</strong></code> -

336

MucRoomUser object describing the user.

337

338

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

339

</dd>

340

<dd><code><strong class="pname">stanza</strong></code> -

341

the stanza received.

342

343

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

344

</dd>

345

</dl>

346

</dd></dl>

347

</td></tr></table>

348

349

350

351

<h3><span class="sig"><span class="sig-name">role_changed</span>(<span class="sig-arg">self</span>,

352

<span class="sig-arg">user</span>,

353

<span class="sig-arg">old_role</span>,

354

<span class="sig-arg">new_role</span>,

355

<span class="sig-arg">stanza</span>)</span>

356

</h3>

357

Called when a role of an user has been changed. <dl><dt></dt><dd>

358

<dl><dt>Parameters:</dt>

359

<dd><code><strong class="pname">user</strong></code> -

360

the user (after update).

361

362

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

363

</dd>

364

<dd><code><strong class="pname">old_role</strong></code> -

365

user's role before update.

366

367

(type=<code>unicode</code>)</em>

368

</dd>

369

<dd><code><strong class="pname">new_role</strong></code> -

370

user's role after update.

371

372

(type=<code>unicode</code>)</em>

373

</dd>

374

<dd><code><strong class="pname">stanza</strong></code> -

375

the stanza received.

376

377

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

378

</dd>

379

</dl>

380

</dd></dl>

381

</td></tr></table>

382

383

384

385

<h3><span class="sig"><span class="sig-name">room_configuration_error</span>(<span class="sig-arg">self</span>,

386

<span class="sig-arg">stanza</span>)</span>

387

</h3>

388

<p>Called when an error stanza is received in reply to a room

389

configuration request.</p>

390

<p>By default <a href="pyxmpp.jabber.muc.MucRoomHandler-class.html#error" class="link"><code>self.error</code></a> is called.</p>

391

392

<dl><dt>Parameters:</dt>

393

<dd><code><strong class="pname">stanza</strong></code> -

394

the stanza received.

395

396

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

397

</dd>

398

</dl>

399

</dd></dl>

400

</td></tr></table>

401

402

403

404

<h3><span class="sig"><span class="sig-name">room_configured</span>(<span class="sig-arg">self</span>)</span>

405

</h3>

406

Called after a successfull room configuration. <dl><dt></dt><dd>

407

</dd></dl>

408

</td></tr></table>

409

410

411

412

<h3><span class="sig"><span class="sig-name">room_created</span>(<span class="sig-arg">self</span>,

413

<span class="sig-arg">stanza</span>)</span>

414

</h3>

415

<p>Called when the room has been created.</p>

416

<p>Default action is to request an "instant room" by accepting the default

417

configuration. Instead the application may want to request a

418

configuration form and submit it.</p>

419

420

<dl><dt>Parameters:</dt>

421

<dd><code><strong class="pname">stanza</strong></code> -

422

the stanza received.

423

424

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

425

</dd>

426

</dl>

427

</dd></dl>

428

</td></tr></table>

429

430

431

432

<h3><span class="sig"><span class="sig-name">subject_changed</span>(<span class="sig-arg">self</span>,

433

<span class="sig-arg">user</span>,

434

<span class="sig-arg">stanza</span>)</span>

435

</h3>

436

Called when the room subject has been changed. <dl><dt></dt><dd>

437

<dl><dt>Parameters:</dt>

438

<dd><code><strong class="pname">user</strong></code> -

439

the user changing the subject.

440

441

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

442

</dd>

443

<dd><code><strong class="pname">stanza</strong></code> -

444

the stanza used to change the subject.

445

446

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

447

</dd>

448

</dl>

449

</dd></dl>

450

</td></tr></table>

451

452

453

454

<h3><span class="sig"><span class="sig-name">user_joined</span>(<span class="sig-arg">self</span>,

455

<span class="sig-arg">user</span>,

456

<span class="sig-arg">stanza</span>)</span>

457

</h3>

458

Called when a new participant joins the room. <dl><dt></dt><dd>

459

<dl><dt>Parameters:</dt>

460

<dd><code><strong class="pname">user</strong></code> -

461

the user joining.

462

463

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

464

</dd>

465

<dd><code><strong class="pname">stanza</strong></code> -

466

the stanza received.

467

468

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

469

</dd>

470

</dl>

471

</dd></dl>

472

</td></tr></table>

473

474

475

476

<h3><span class="sig"><span class="sig-name">user_left</span>(<span class="sig-arg">self</span>,

477

<span class="sig-arg">user</span>,

478

<span class="sig-arg">stanza</span>)</span>

479

</h3>

480

Called when a participant leaves the room. <dl><dt></dt><dd>

481

<dl><dt>Parameters:</dt>

482

<dd><code><strong class="pname">user</strong></code> -

483

the user leaving.

484

485

(type=<a href="pyxmpp.jabber.muc.MucRoomUser-class.html" class="link"><code>MucRoomUser</code></a>)</em>

486

</dd>

487

<dd><code><strong class="pname">stanza</strong></code> -

488

the stanza received.

489

490

(type=<a href="pyxmpp.stanza.Stanza-class.html" class="link"><code>pyxmpp.stanza.Stanza</code></a>)</em>

491

</dd>

492

</dl>

493

</dd></dl>

494

</td></tr></table>

495

<br />

496

497

498

499

500

501

<th colspan="2">Instance Variable Details</th></tr>

502

</table>

503

504

505

<h3>room_state</h3>

506

MucRoomState object describing room state and its

507

participants.</td></tr></table>

508

<br />

509

510

511

512

513

514

515

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

516

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

517

518

519

520

521

522

<a class="navbar" target="_top" href="http://pyxmpp.jabberstudio.org/">PyXMPP</a>

523

</p></th></tr></table>

524

</th>

525

</tr>

526

</table>

527

528

529

<tr>

530

<td align="left" class="footer">Generated by Epydoc 2.1 on Mon Dec 26 17:57:49 2005</td>

531

532

<a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>

533

</td>

534

</tr>

535

</table>

536

</body>

537

</html>

Older »