PyDestinationContentReferenceFinder
class PyDestinationContentReferenceFinder(destination_content_reference_finder, t)
Bases: Generic
[TContent
]
Interface for an object that can find destination content reference for given content information, applying mapping rules.
- Parameters:
- destination_content_reference_finder (IDestinationContentReferenceFinder [ ])
- t (Type *[*TContent ])
__init__(destination_content_reference_finder, t)
Creates a new PyDestinationContentReferenceFinder object.
Args: : destination_content_reference_finder: A IDestinationContentReferenceFinder object. t: The content type.
Returns: None.
- Parameters:
- destination_content_reference_finder (IDestinationContentReferenceFinder [ ])
- t (Type *[*TContent ])
- Return type: None
Methods
__init__ (destination_content_reference_finder, t) |
Creates a new PyDestinationContentReferenceFinder object. |
---|---|
find_by_id (id[, cancel]) |
Finds the content reference by its unique identifier. |
find_by_mapped_location (mapped_location[, ...]) |
Finds the destination content reference for the mapped destination content reference location. |
find_by_source_content_url (source_content_url) |
Finds the destination content reference for the source content reference URL. |
find_by_source_id (source_id[, cancel]) |
Finds the destination content reference for the source content reference unique identifier. |
find_by_source_location (source_location[, ...]) |
Finds the destination content reference for the source content reference location. |
find_by_id(id, cancel=None)
Finds the content reference by its unique identifier.
Args: : id: The unique identifier. cancel: A cancellation token to obey.
Returns: The found content reference, or None if no content reference was found.
- Parameters: id (UUID)
- Return type: PyContentReference
find_by_mapped_location(mapped_location, cancel=None)
Finds the destination content reference for the mapped destination content reference location.
Args: : mapped_location: The destination mapped content reference location. cancel: A cancellation token to obey.
Returns: The found destination content reference, or None if no content reference was found.
- Parameters: mapped_location (PyContentLocation)
- Return type: PyContentReference
find_by_source_content_url(source_content_url, cancel=None)
Finds the destination content reference for the source content reference URL.
Args: : source_content_url: The source content reference URL. cancel: A cancellation token to obey.
Returns: The found destination content reference, or None if no content reference was found.
- Parameters: source_content_url (str)
- Return type: PyContentReference
find_by_source_id(source_id, cancel=None)
Finds the destination content reference for the source content reference unique identifier.
Args: : source_id: The source content reference unique identifier. cancel: A cancellation token to obey.
Returns: The found destination content reference, or None if no content reference was found.
- Parameters: source_id (UUID)
- Return type: PyContentReference
find_by_source_location(source_location, cancel=None)
Finds the destination content reference for the source content reference location.
Args: : source_location: The source content reference location. cancel: A cancellation token to obey.
Returns: The found destination content reference, or None if no content reference was found.
- Parameters: source_location (PyContentLocation)
- Return type: PyContentReference