Subscription.xml 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <Type Name="Subscription" FullName="Urho.Subscription">
  2. <TypeSignature Language="C#" Value="public class Subscription : IDisposable" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Subscription extends System.Object implements class System.IDisposable" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>System.Object</BaseTypeName>
  10. </Base>
  11. <Interfaces>
  12. <Interface>
  13. <InterfaceName>System.IDisposable</InterfaceName>
  14. </Interface>
  15. </Interfaces>
  16. <Docs>
  17. <summary>Encapsulates the subscription to an event, the main use is to stop event delivery by unsubscribing or disposing.</summary>
  18. <remarks>Instances of Subscription are returned from the various Subscribe methods exposed by the UrhoObject class.   When you want to stop receiving notifications for a subscription, invoke the <see cref="M:Urho.Subscription.Unsubscribe" /> method or the <see cref="M:System.IDisposable.Dispose" /> method.</remarks>
  19. </Docs>
  20. <Members>
  21. <Member MemberName="Dispose">
  22. <MemberSignature Language="C#" Value="public void Dispose ();" />
  23. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
  24. <MemberType>Method</MemberType>
  25. <AssemblyInfo>
  26. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  27. </AssemblyInfo>
  28. <ReturnValue>
  29. <ReturnType>System.Void</ReturnType>
  30. </ReturnValue>
  31. <Parameters />
  32. <Docs>
  33. <summary>To be added.</summary>
  34. <remarks>To be added.</remarks>
  35. </Docs>
  36. </Member>
  37. <Member MemberName="Unsubscribe">
  38. <MemberSignature Language="C#" Value="public void Unsubscribe ();" />
  39. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Unsubscribe() cil managed" />
  40. <MemberType>Method</MemberType>
  41. <AssemblyInfo>
  42. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  43. </AssemblyInfo>
  44. <ReturnValue>
  45. <ReturnType>System.Void</ReturnType>
  46. </ReturnValue>
  47. <Parameters />
  48. <Docs>
  49. <summary>Unsubscribes from receiving notifications.</summary>
  50. <remarks>
  51. <para />
  52. </remarks>
  53. </Docs>
  54. </Member>
  55. </Members>
  56. </Type>