XmpIptcIimPackage class Leave feedback

XmpIptcIimPackage class

Represents the IPTC-IIM XMP package.

Inheritance: XmpIptcIimPackage → XmpPackage → XmpMetadataContainer → CustomPackage → MetadataPackage

The XmpIptcIimPackage type exposes the following members:

Constructors

Constructor	Description
`__init__(self)`	Initializes a new instance of the `XmpIptcIimPackage` class.

Properties

Property	Description
metadata_type	Gets the metadata type.
keys	Gets a collection of the metadata property names.
property_descriptors	Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count	Gets the number of metadata properties.
prefix	Gets the xmlns prefix.
namespace_uri	Gets the namespace URI.
xml_namespace	Gets the XML namespace.
model_version	Gets or sets the binary number identifying the version of the Information
destination	Gets or sets the destination. This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.
file_format	Gets or sets the binary number identifying the version of the Information
file_format_version	Gets or sets the file format version.
service_identifier	Gets or sets the service identifier. Identifies the provider and product.
envelope_number	Gets or sets the envelope number.
product_i_ds	Gets or sets the product identifiers.
envelope_priority	Gets or sets the envelope handling priority.
date_sent	Gets or sets the date the service sent the material.
unique_name_of_object	Gets or sets the unique name of the object.
object_type_reference	Gets or sets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM.
edit_status	Gets or sets the status of the object data, according to the practice of the provider.
urgency	Gets or sets the editorial urgency of the content.
category	Gets or sets the subject of the object data in the opinion of the provider.
supplemental_categories	Gets or sets the supplemental categories.
fixture_identifier	Gets or sets the object data that recurs often and predictably.
content_location_codes	Gets or sets the content location codes.
content_location_names	Gets or sets the content location names.
release_date	Gets or sets the earliest date the provider intends the object to be used.
expiration_date	Gets or sets the latest date the provider or owner intends the object data to be used.
action_advised	Gets or sets the type of action that this object provides to a previous object.
reference_service	Gets or sets the Service Identifier of a prior envelope to which the current object refers.
reference_date	Gets or sets the date of a prior envelope to which the current object refers.
reference_number	Gets or sets the Envelope Number of a prior envelope to which the current object refers.
digital_creation_date	Gets or sets the date the digital representation of the object data was created.
originating_program	Gets or sets the type of program used to originate the object data.
program_version	Gets or sets the program version.
image_type	Gets or sets the type of the image.
image_orientation	Gets or sets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square).
language_identifier	Gets or sets the language identifier according to the 2-letter codes of ISO 639:1988.

Methods

Method	Description
`set(self, name, value)`	Sets string property.
`set(self, name, value)`	Sets integer property.
`set(self, name, value)`	Sets boolean property.
`set(self, name, value)`	Sets DateTime property.
`set(self, name, value)`	Sets double property.
`set(self, name, value)`	Sets the value inherited from `XmpValueBase` .
`set(self, name, value)`	Sets the value inherited from `XmpComplexType` .
`set(self, name, value)`	Sets the value inherited from `XmpArray` .
`contains(self, property_name)`	Determines whether the package contains a metadata property with the specified name.
`find_properties(self, specification)`	Finds the metadata properties satisfying a specification. The search is recursive so it affects all nested packages as well.
`update_properties(self, specification, value)`	Updates known metadata properties satisfying a specification. The operation is recursive so it affects all nested packages as well.
`remove_properties(self, specification)`	Removes metadata properties satisfying a specification.
`add_properties(self, specification, value)`	Adds known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well.
`set_properties(self, specification, value)`	Sets known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well. This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`. If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package.
`sanitize(self)`	Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.
`get_xmp_representation(self)`	Converts the XMP value to the XML representation.
`remove(self, name)`	Removes the property with the specified name.
`clear(self)`	Removes all XMP properties.

XmpIptcIimPackage class Leave feedback

On this page

XmpIptcIimPackage class

Constructors

Properties

Methods

See Also

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!

On this page