mark slap classes as deprecated
This commit is contained in:
parent
744e194b90
commit
d2cdbd2aff
3 changed files with 7 additions and 0 deletions
|
|
@ -63,6 +63,7 @@ module DiasporaFederation
|
||||||
#
|
#
|
||||||
# entity = slap.entity(author_pubkey)
|
# entity = slap.entity(author_pubkey)
|
||||||
#
|
#
|
||||||
|
# @deprecated
|
||||||
class EncryptedSlap < Slap
|
class EncryptedSlap < Slap
|
||||||
# the key and iv if it is an encrypted slap
|
# the key and iv if it is an encrypted slap
|
||||||
# @param [Hash] value hash containing the key and iv
|
# @param [Hash] value hash containing the key and iv
|
||||||
|
|
|
||||||
|
|
@ -1,18 +1,22 @@
|
||||||
module DiasporaFederation
|
module DiasporaFederation
|
||||||
module Salmon
|
module Salmon
|
||||||
# Raised, if the element containing the Magic Envelope is missing from the XML
|
# Raised, if the element containing the Magic Envelope is missing from the XML
|
||||||
|
# @deprecated
|
||||||
class MissingMagicEnvelope < RuntimeError
|
class MissingMagicEnvelope < RuntimeError
|
||||||
end
|
end
|
||||||
|
|
||||||
# Raised, if the element containing the author is empty.
|
# Raised, if the element containing the author is empty.
|
||||||
|
# @deprecated
|
||||||
class MissingAuthor < RuntimeError
|
class MissingAuthor < RuntimeError
|
||||||
end
|
end
|
||||||
|
|
||||||
# Raised, if the element containing the header is missing from the XML
|
# Raised, if the element containing the header is missing from the XML
|
||||||
|
# @deprecated
|
||||||
class MissingHeader < RuntimeError
|
class MissingHeader < RuntimeError
|
||||||
end
|
end
|
||||||
|
|
||||||
# Raised if the decrypted header has an unexpected XML structure
|
# Raised if the decrypted header has an unexpected XML structure
|
||||||
|
# @deprecated
|
||||||
class InvalidHeader < RuntimeError
|
class InvalidHeader < RuntimeError
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,6 +25,8 @@ module DiasporaFederation
|
||||||
# author_pubkey = however_you_retrieve_the_authors_public_key(slap.author_id)
|
# author_pubkey = however_you_retrieve_the_authors_public_key(slap.author_id)
|
||||||
#
|
#
|
||||||
# entity = slap.entity(author_pubkey)
|
# entity = slap.entity(author_pubkey)
|
||||||
|
#
|
||||||
|
# @deprecated
|
||||||
class Slap
|
class Slap
|
||||||
# the author of the slap
|
# the author of the slap
|
||||||
# @overload author_id
|
# @overload author_id
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue