Table of Contents

Interface IContactGroupMemberInfoProvider

Namespace
CMS.ContactManagement
Assembly
CMS.ContactManagement.dll

Declares members for ContactGroupMemberInfo management.

[Obsolete("Use CMS.DataEngine.IInfoProvider<ContactGroupMemberInfo> instead. Use CMS.DataEngine.InfoProviderExtensions for additional methods for individual objects retrieval. To get an instance of the interface's implementation use dependency injection or access the instance directly via the CMS.DataEngine.Provider<ContactGroupMemberInfo>.Instance property.")]
[ObsoleteSince(29, 0)]
public interface IContactGroupMemberInfoProvider : IInfoProvider<ContactGroupMemberInfo>, IInfoByIdProvider<ContactGroupMemberInfo>
Inherited Members
Extension Methods

Methods

Add(int, int, ContactGroupMemberTypeEnum, MemberAddedHowEnum)

Creates ContactGroupMemberInfo binding.

[Obsolete("Use CMS.ContactManagement.ContactGroupMemberInfoProviderExtensions.Add(this IInfoProvider<ContactGroupMemberInfo>, int, int, ContactGroupMemberTypeEnum, MemberAddedHowEnum) instead.")]
[ObsoleteSince(29, 0)]
void Add(int contactGroupId, int relatedObjectId, ContactGroupMemberTypeEnum memberType, MemberAddedHowEnum addedHow)

Parameters

contactGroupId int

Contact group ID.

relatedObjectId int

Related object ID.

memberType ContactGroupMemberTypeEnum

Member type.

addedHow MemberAddedHowEnum

Possible types of contact addition into contact group.

Get(int, int, ContactGroupMemberTypeEnum)

Gets an instance of the ContactGroupMemberInfo binding structure.

[Obsolete("Use Get() and parametrized ObjectQuery to get the ContactGroupMemberInfo with specified ContactGroupMemberContactGroupID, ContactGroupMemberRelatedID and ContactGroupMemberType.")]
[ObsoleteSince(29, 0)]
ContactGroupMemberInfo Get(int contactGroupId, int relatedObjectId, ContactGroupMemberTypeEnum memberType)

Parameters

contactGroupId int

Contact group ID.

relatedObjectId int

Related object ID.

memberType ContactGroupMemberTypeEnum

Member type.

Returns

ContactGroupMemberInfo

Returns an instance of ContactGroupMemberInfo corresponding to given identifiers or null.

GetAsync(int, int, ContactGroupMemberTypeEnum, CancellationToken?)

Asynchronously gets an instance of the ContactGroupMemberInfo binding structure.

[Obsolete("Use Get() and parametrized ObjectQuery to get the ContactGroupMemberInfo with specified ContactGroupMemberContactGroupID, ContactGroupMemberRelatedID and ContactGroupMemberType.")]
[ObsoleteSince(29, 0)]
Task<ContactGroupMemberInfo> GetAsync(int contactGroupId, int relatedObjectId, ContactGroupMemberTypeEnum memberType, CancellationToken? cancellationToken = null)

Parameters

contactGroupId int

Contact group ID.

relatedObjectId int

Related object ID.

memberType ContactGroupMemberTypeEnum

Member type.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<ContactGroupMemberInfo>

Returns a task returning either an instance of ContactGroupMemberInfo corresponding to given identifiers or null.

Remove(int, int, ContactGroupMemberTypeEnum)

Deletes ContactGroupMemberInfo binding.

[Obsolete("Get the ContactGroupMemberInfo with specified ContactGroupMemberContactGroupID, ContactGroupMemberRelatedID and ContactGroupMemberType using Get() and delete the binding using Delete(ContactGroupMemberInfo).")]
[ObsoleteSince(29, 0)]
void Remove(int contactGroupId, int relatedObjectId, ContactGroupMemberTypeEnum memberType)

Parameters

contactGroupId int

Contact group ID.

relatedObjectId int

Related object ID.

memberType ContactGroupMemberTypeEnum

Member type.