Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

createProfileRelationship

  • description

    Create Profile Relationship

    async
    since

    2.39.0

    example
     createProfileRelationship({
    relationshipTypeKey: "follow",
    toProfileId: "<Profile ID>",
    fromProfileId: "<Profile ID>",
    }).then((profileRelationship) => console.log(profileRelationship))
    ``

    Parameters

    Returns Promise<IProfileRelationship>

deleteProfileRelationship

  • description

    Delete Profile Relationship

    async
    since

    2.39.0

    example
    deleteProfileRelationship({ relationshipId: "<Profile Relationship ID>" })
    ``

    Parameters

    Returns Promise<null>

Const getProfileRelationshipDetails

  • Gets profile relationship detail from relationshipId.

    async
    since

    2.39.0

    example
    getProfileRelationshipDetails({
    relationshipId: "<Profile Relationship ID>"
    }).then(profileRelationship => console.log(profileRelationship))

    Parameters

    Returns Promise<IProfileRelationship>

getProfileRelationshipTypes

getProfileRelationships

  • description

    Get list of Profile Relationships

    async
    since

    2.39.0

    example
    getProfileRelationships({
    relationshipTypeKey: "follow",
    toProfileId: "<Profile ID>",
    fromProfileId: "<Profile ID>",
    }).then(({results}) => console.log(results))

    Parameters

    Returns Promise<IPaginatedResponse<IProfileRelationship>>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc