Method alias

src/wechaty/user/contact.py:401–437

Get or set alias of contact. If new_alias is given, it will set alias to new_alias, otherwise return current alias Notes: Setting aliases too often will result in failure (60 times per minute). Args: new_alias: the new alias

(self,
                    new_alias: Optional[str] = None
                    )

        return self.payload.name

    async def alias(self,
                    new_alias: Optional[str] = None
                    ) -> Union[None, str]:
        """
        Get or set alias of contact.
        
        If new_alias is given, it will set alias to new_alias,
        otherwise return current alias

        Notes:
            Setting aliases too often will result in failure (60 times per minute).

        Args:
            new_alias: the new alias of contact.

        Returns:
            alias: the current alias of contact
        """
        log.info('Contact alias <%s>', new_alias)
        if not self.is_ready():
            await self.ready()

        if self.payload is None:
            raise WechatyPayloadError('can"t load contact payload <%s>' % self)

        try:
            alias = await self.puppet.contact_alias(self.contact_id, new_alias)

            # reload the contact payload
            await self.ready(force_sync=True)
            return alias
        # pylint:disable=W0703
        except Exception as exception:
            log.info(
                'Contact alias(%s) rejected: %s',
                new_alias, str(exception.args))
        return None

    def is_friend(self) -> Optional[bool]:
        """