<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Cancel a subscription to a specified topic.</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="samconnection.subscribe.html">SAMConnection::subscribe</a></div> <div class="next" style="text-align: right; float: right;"><a href="sammessage.body.html">SAMMessage::body</a></div> <div class="up"><a href="ref.sam.html">SAM Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="samconnection.unsubscribe" class="refentry"> <div class="refnamediv"> <h1 class="refname">SAMConnection::unsubscribe</h1> <p class="verinfo">(PECL sam >= 0.1.0)</p><p class="refpurpose"><span class="refname">SAMConnection::unsubscribe</span> — <span class="dc-title"> Cancel a subscription to a specified topic. </span></p> </div> <div class="refsect1 description" id="refsect1-samconnection.unsubscribe-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>SAMConnection::unsubscribe</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$subscriptionId</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$targetTopic</code></span> ] )</div> <p class="para rdfs-comment"> The "unsubscribe" method is used to delete an existing subscription to a specified topic. </p> </div> <div class="refsect1 parameters" id="refsect1-samconnection.unsubscribe-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">subscriptionId</code></em></span> <dd> <p class="para"> The identifier of an existing subscription as returned by a call to the subscribe method. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-samconnection.unsubscribe-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> This method returns <strong><code>FALSE</code></strong> if an error occurs. </p> </div> <div class="refsect1 examples" id="refsect1-samconnection.unsubscribe-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4539"> <p><strong>Example #1 Delete a subscription</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">unsubscribe</span><span style="color: #007700">(</span><span style="color: #0000BB">$subid</span><span style="color: #007700">)) {<br /> </span><span style="color: #FF8000">// The unsubscribe failed!<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"Unsubscribe failed (</span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">errno</span><span style="color: #DD0000">) </span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">error</span><span style="color: #DD0000">"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-samconnection.unsubscribe-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="samconnection.subscribe.html" class="xref">SAMConnection::subscribe</a></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="samconnection.subscribe.html">SAMConnection::subscribe</a></div> <div class="next" style="text-align: right; float: right;"><a href="sammessage.body.html">SAMMessage::body</a></div> <div class="up"><a href="ref.sam.html">SAM Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>